Impansible

Library version:0.7
Library scope:TEST
Named arguments:supported

Introduction

Robotframework library to access all ansible internal modules. All Ansible modules are available as Robotframework's keywords. The Impansible library can be used without Robotframework.

Table of contents

Examples

${x}= Setup localhost
${x}= apt localhost package=${PAC} state=present
${c}= get certificate localhost host=www.onet.pl port=443 proxy_host=1.1.1.1
*** Variables ***
${PAC}   mtr
${ansible_password}  secret

*** Settings ***
library  Impansible
library  Collections
library  OperatingSystem

*** Test Cases ***
test 1
        ${x}=   Setup  localhost
        ${y}=   get from dictionary  ${x}   ansible_facts
        ${h}=   get from dictionary  ${y}   ansible_hostname
        ${z}=   get from dictionary  ${y}   ansible_distribution
        Should be Equal  ${z}  Ubuntu
        Should Contain   ${h}  tester
test 2
        [Timeout]    600
        ${x}=   apt    localhost   package=${PAC}   state=present
        ${x}=   get from dictionary  ${x}   invocation
        ${y}=   get from dictionary  ${x}   module_args
        ${s}=   get from dictionary  ${y}   state
        Should be Equal  ${s}  present
        ${w}=   Run     which ${PAC}
        Should Contain  ${w}  ${PAC}

test 3
        [Timeout]    600
        ${x}=   apt   localhost   package=${PAC}   state=absent
        ${x}=   get from dictionary  ${x}   invocation
        ${y}=   get from dictionary  ${x}   module_args
        ${s}=   get from dictionary  ${y}   state
        Should be Equal  ${s}  absent
        ${w}=   Run     which ${PAC}
        Should not Contain  ${w}  ${PAC}

test 4
        ${x}=   apt    localhost   package=python-openssl   state=present
        ${c}=   get certificate   localhost  host=www.onet.pl   port=443  proxy_host=1.1.1.1
        ${e}=   get from dictionary  ${c}   expired
        Should not be True   ${e}

test 5
        ${x}=  nitz2
        log  ${x}

test 6
        ${w}=   command   localhost   uname -a
        ${w}=   get from dictionary  ${w}   stdout
        Should Contain  ${w}  GNU/Linux
# sudo access example:


*** settings ***
Library  Impansible
Library  Collections

*** variables ***
${hostname}   localhost
# without sudo
#${ansible_password}  root_password
# with sudo
${ansible_user}  user_name
${ansible_become_password}  user_password

*** test cases ***
test 1
      ${x}=   Setup  ${hostname}
        ${y}=   get from dictionary  ${x}   ansible_facts
        ${z}=   get from dictionary  ${y}   ansible_distribution
        Should be Equal  ${z}  Ubuntu
test 2
      ${x}=   command  ${hostname}  id
      ${x}=   get from dictionary  ${x}  stdout
        Should Contain   ${x}  root

`

# Requirements for selenium tests
`
*** Variables ***
${BROWSER}  firefox
${ansible_password}  XXXXXXX
${DBHost}  localhost
${DBName}  w3schools
${DBUser}  XXXXXX
${DBPass}  XXXXXX
${DBPort}  3306
${DBFile}  w3schools.sql
${Furl}    https://raw.githubusercontent.com/AndrejPHP/w3schools-database/master/w3schools.sql
${gr}      /etc/apt/sources.list.d/google-chrome.list
${grep}    http://mirror.cs.uchicago.edu/google-chrome/pool/main/g/google-chrome-stable/
#${chrome_version}  False
${chrome_version}  google-chrome-stable_81.0.4044.138-1_amd64.deb

*** Settings ***
Library  Impansible
library  Collections
library  OperatingSystem
library  String
#Library  DatabaseLibrary
Libarary  SeleniumLibrary

*** Test Cases ***
do wp.pl tests
      [Setup]   Requirements
      Open Browser  http://wp.pl  ${BROWSER}
      ${t}=  Get Title
      Should contain  ${t}  Wirtualna


*** Keywords ***
Requirements
      The Operating System should be Ubuntu
      The Firefox browser should be installed if needed
      The Geckodriver should be installed if needed
      The google repo should be available
      The Chrome should be installed if needed
      The Chromedriver should be installed if needed
      #The MySQL server should be installed
      #Python should have MySQL support
      #The MySQL user have all privileges
      #Mysql should have no database imported
      #Mysql should have database imported

The Operating System should be Ubuntu
      ${x}=   Setup  localhost
      ${y}=   get from dictionary  ${x}   ansible_facts
      ${z}=   get from dictionary  ${y}   ansible_distribution
      Should be Equal  ${z}  Ubuntu

The Firefox browser should be installed if needed
      [Timeout]    600
      ${x}=  Convert To Lower Case  ${BROWSER}
      ${x}=  Run Keyword and return status  Should Contain  ${x}  firefox
      Return from keyword if  not ${x}
      ${x}=   apt    localhost   package=firefox   state=present
        ${x}= get from dictionary  ${x}   invocation
        ${y}= get from dictionary  ${x}   module_args
        ${s}= get from dictionary  ${y}   state
        Should be Equal  ${s}  present
      ${w}=   Run     which firefox
      Should Contain  ${w}  firefox

The Geckodriver should be installed if needed
      [Timeout]    600
      ${x}=  Convert To Lower Case  ${BROWSER}
      ${x}=  Run Keyword and return status  Should Contain  ${x}  firefox
      Return from keyword if  not ${x}
      ${x}=   apt    localhost   package=firefox-geckodriver   state=present
        ${x}= get from dictionary  ${x}   invocation
        ${y}= get from dictionary  ${x}   module_args
        ${s}= get from dictionary  ${y}   state
        Should be Equal  ${s}  present
      ${w}=   Run     which geckodriver
      Should Contain  ${w}  geckodriver

The Chrome should be installed if needed
      [Timeout]    600
      ${x}=  Convert To Lower Case  ${BROWSER}
      ${x}=  Run Keyword and return status  Should Contain  ${x}  chrome
             Return from keyword if  not ${x}
      ${w}=   Run     which google-chrome-stable
      ${x}=   run keyword and return status  Should Contain  ${w}  google-chrome-stable
              Return from keyword if  ${x}
              run keyword if  "${chrome_version}"!="False"  apt  localhost  deb="${grep}${chrome_version}"
      ${x}=   apt    localhost   package=google-chrome-stable   state=present
        ${x}= get from dictionary  ${x}   invocation
        ${y}= get from dictionary  ${x}   module_args
        ${s}= get from dictionary  ${y}   state
        Should be Equal  ${s}  present
      ${w}=   Run     which google-chrome-stable
      Should Contain  ${w}  google-chrome-stable

The Chromedriver should be installed if needed
      [Timeout]    600
      ${x}=  Convert To Lower Case  ${BROWSER}
      ${x}=  Run Keyword and return status  Should Contain  ${x}  chrome
      Return from keyword if  not ${x}
      ${x}=   apt    localhost   package=chromium-chromedriver   state=present
        ${x}= get from dictionary  ${x}   invocation
        ${y}= get from dictionary  ${x}   module_args
        ${s}= get from dictionary  ${y}   state
        Should be Equal  ${s}  present
      ${w}=   Run     which chromedriver
      Should Contain  ${w}  chromedriver

The MySQL server should be installed
      [Timeout]    600
      ${x}=   apt    localhost   package=mysql-server   state=present
      ${x}=   get from dictionary  ${x}   invocation
      ${y}=   get from dictionary  ${x}   module_args
      ${s}=   get from dictionary  ${y}   state
              Should be Equal  ${s}  present
      ${w}=   Run     which mysqld
              Should Contain  ${w}  mysqld

Python should have MySQL support
      [Timeout]    600
      ${x}=   apt    localhost   package=python-mysqldb   state=present
      ${x}=   get from dictionary  ${x}   invocation
      ${y}=   get from dictionary  ${x}   module_args
      ${s}=   get from dictionary  ${y}   state
              Should be Equal  ${s}  present

The MySQL user have all privileges
      [Timeout]    600
      ${x}=   apt    localhost   package=python-mysqldb   state=present
      ${x}=   get from dictionary  ${x}   invocation
      ${y}=   get from dictionary  ${x}   module_args
      ${s}=   get from dictionary  ${y}   state
              Should be Equal  ${s}  present
              mysql_user  localhost  name=${DBUser}  password=${DBPass}  priv=*.*:ALL

Mysql should have no database imported
      [Timeout]    600
      mysql db  localhost  name=${DBName}  state=absent

Mysql should have database imported
      [Timeout]    600
      mysql db  localhost  name=${DBName}  state=present
      Get url   localhost  url=${Furl}     dest=/tmp/${DBFile}
      mysql db  localhost  name=${DBName}  state=import  target=/tmp/${DBFile}

Mysql requirements
      The MySQL server should be installed
      Python should have MySQL support
      Mysql should have no database imported
      Mysql should have database imported
      The MySQL user have all privileges

The google repo should be available
      [Timeout]    600
      ${x}=   Stat  localhost  path="${gr}"
        ${x}=   get from dictionary  ${x}   stat
        ${x}=   get from dictionary  ${x}   exists
              run keyword if  not ${x}  Copy  localhost  content='deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main'  dest="${gr}"
              run keyword if  not ${x}  shell  localhost  wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | apt-key add -
              run keyword if  not ${x}  apt  localhost  update_cache=yes
      ${x}=   Stat  localhost  path="${gr}"
        ${x}=   get from dictionary  ${x}   stat
        ${x}=   get from dictionary  ${x}   exists
      Should be true  ${x}   "The google repo is not available"

`

Shortcuts

A10 Server · A10 Server Axapi3 · A10 Service Group · A10 Virtual Server · Aci Aaa User · Aci Aaa User Certificate · Aci Access Port Block To Access Port · Aci Access Port To Interface Policy Leaf Profile · Aci Access Sub Port Block To Access Port · Aci Aep · Aci Aep To Domain · Aci Ap · Aci Bd · Aci Bd Subnet · Aci Bd To L3out · Aci Config Rollback · Aci Config Snapshot · Aci Contract · Aci Contract Subject · Aci Contract Subject To Filter · Aci Domain · Aci Domain To Encap Pool · Aci Domain To Vlan Pool · Aci Encap Pool · Aci Encap Pool Range · Aci Epg · Aci Epg Monitoring Policy · Aci Epg To Contract · Aci Epg To Domain · Aci Fabric Node · Aci Fabric Scheduler · Aci Filter · Aci Filter Entry · Aci Firmware Group · Aci Firmware Group Node · Aci Firmware Policy · Aci Firmware Source · Aci Interface Policy Cdp · Aci Interface Policy Fc · Aci Interface Policy L2 · Aci Interface Policy Leaf Policy Group · Aci Interface Policy Leaf Profile · Aci Interface Policy Lldp · Aci Interface Policy Mcp · Aci Interface Policy Ospf · Aci Interface Policy Port Channel · Aci Interface Policy Port Security · Aci Interface Selector To Switch Policy Leaf Profile · Aci L3out · Aci L3out Extepg · Aci L3out Extsubnet · Aci L3out Route Tag Policy · Aci Maintenance Group · Aci Maintenance Group Node · Aci Maintenance Policy · Aci Rest · Aci Static Binding To Epg · Aci Switch Leaf Selector · Aci Switch Policy Leaf Profile · Aci Switch Policy Vpc Protection Group · Aci Taboo Contract · Aci Tenant · Aci Tenant Action Rule Profile · Aci Tenant Ep Retention Policy · Aci Tenant Span Dst Group · Aci Tenant Span Src Group · Aci Tenant Span Src Group To Dst Group · Aci Vlan Pool · Aci Vlan Pool Encap Block · Aci Vmm Credential · Aci Vrf · Acl · Acme Account · Acme Account Info · Acme Certificate · Acme Certificate Revoke · Acme Challenge Cert Helper · Acme Inspect · Add Host · Aerospike Migrations · Airbrake Deployment · Aireos Command · Aireos Config · Aix Devices · Aix Filesystem · Aix Inittab · Aix Lvg · Aix Lvol · Ali Instance · Ali Instance Info · Alternatives · Apache2 Mod Proxy · Apache2 Module · Apk · Apt · Apt Key · Apt Repo · Apt Repository · Apt Rpm · Archive · Aruba Command · Aruba Config · Asa Acl · Asa Command · Asa Config · Asa Og · Assemble · Assert · Async Status · Async Wrapper · At · Atomic Container · Atomic Host · Atomic Image · Authorized Key · Avi Actiongroupconfig · Avi Alertconfig · Avi Alertemailconfig · Avi Alertscriptconfig · Avi Alertsyslogconfig · Avi Analyticsprofile · Avi Api Session · Avi Api Version · Avi Applicationpersistenceprofile · Avi Applicationprofile · Avi Authprofile · Avi Autoscalelaunchconfig · Avi Backup · Avi Backupconfiguration · Avi Certificatemanagementprofile · Avi Cloud · Avi Cloudconnectoruser · Avi Cloudproperties · Avi Cluster · Avi Clusterclouddetails · Avi Controllerproperties · Avi Customipamdnsprofile · Avi Dnspolicy · Avi Errorpagebody · Avi Errorpageprofile · Avi Gslb · Avi Gslbgeodbprofile · Avi Gslbservice · Avi Gslbservice Patch Member · Avi Hardwaresecuritymodulegroup · Avi Healthmonitor · Avi Httppolicyset · Avi Ipaddrgroup · Avi Ipamdnsproviderprofile · Avi L4policyset · Avi Microservicegroup · Avi Network · Avi Networkprofile · Avi Networksecuritypolicy · Avi Pkiprofile · Avi Pool · Avi Poolgroup · Avi Poolgroupdeploymentpolicy · Avi Prioritylabels · Avi Role · Avi Scheduler · Avi Seproperties · Avi Serverautoscalepolicy · Avi Serviceengine · Avi Serviceenginegroup · Avi Snmptrapprofile · Avi Sslkeyandcertificate · Avi Sslprofile · Avi Stringgroup · Avi Systemconfiguration · Avi Tenant · Avi Trafficcloneprofile · Avi User · Avi Useraccount · Avi Useraccountprofile · Avi Virtualservice · Avi Vrfcontext · Avi Vsdatascriptset · Avi Vsvip · Avi Webhook · Awall · Aws Acm Info · Aws Api Gateway · Aws Application Scaling Policy · Aws Az Info · Aws Batch Compute Environment · Aws Batch Job Definition · Aws Batch Job Queue · Aws Caller Info · Aws Codebuild · Aws Codecommit · Aws Codepipeline · Aws Config Aggregation Authorization · Aws Config Aggregator · Aws Config Delivery Channel · Aws Config Recorder · Aws Config Rule · Aws Direct Connect Connection · Aws Direct Connect Gateway · Aws Direct Connect Link Aggregation Group · Aws Direct Connect Virtual Interface · Aws Eks Cluster · Aws Elasticbeanstalk App · Aws Glue Connection · Aws Glue Job · Aws Inspector Target · Aws Kms · Aws Kms Info · Aws Netapp Cvs Active Directory · Aws Netapp Cvs FileSystems · Aws Netapp Cvs Pool · Aws Netapp Cvs Snapshots · Aws Region Info · Aws S3 · Aws S3 Bucket Info · Aws S3 Cors · Aws Secret · Aws Ses Identity · Aws Ses Identity Policy · Aws Ses Rule Set · Aws Sgw Info · Aws Ssm Parameter Store · Aws Waf Condition · Aws Waf Info · Aws Waf Rule · Aws Waf Web Acl · Azure Rm Acs · Azure Rm Aks · Azure Rm Aks Info · Azure Rm Aksversion Info · Azure Rm Appgateway · Azure Rm Applicationsecuritygroup · Azure Rm Applicationsecuritygroup Info · Azure Rm Appserviceplan · Azure Rm Appserviceplan Info · Azure Rm Automationaccount · Azure Rm Automationaccount Info · Azure Rm Autoscale · Azure Rm Autoscale Info · Azure Rm Availabilityset · Azure Rm Availabilityset Info · Azure Rm Azurefirewall · Azure Rm Azurefirewall Info · Azure Rm Batchaccount · Azure Rm Cdnendpoint · Azure Rm Cdnendpoint Info · Azure Rm Cdnprofile · Azure Rm Cdnprofile Info · Azure Rm Containerinstance · Azure Rm Containerinstance Info · Azure Rm Containerregistry · Azure Rm Containerregistry Info · Azure Rm Cosmosdbaccount · Azure Rm Cosmosdbaccount Info · Azure Rm Deployment · Azure Rm Deployment Info · Azure Rm Devtestlab · Azure Rm Devtestlab Info · Azure Rm Devtestlabarmtemplate Info · Azure Rm Devtestlabartifact Info · Azure Rm Devtestlabartifactsource · Azure Rm Devtestlabartifactsource Info · Azure Rm Devtestlabcustomimage · Azure Rm Devtestlabcustomimage Info · Azure Rm Devtestlabenvironment · Azure Rm Devtestlabenvironment Info · Azure Rm Devtestlabpolicy · Azure Rm Devtestlabpolicy Info · Azure Rm Devtestlabschedule · Azure Rm Devtestlabschedule Info · Azure Rm Devtestlabvirtualmachine · Azure Rm Devtestlabvirtualmachine Info · Azure Rm Devtestlabvirtualnetwork · Azure Rm Devtestlabvirtualnetwork Info · Azure Rm Dnsrecordset · Azure Rm Dnsrecordset Info · Azure Rm Dnszone · Azure Rm Dnszone Info · Azure Rm Functionapp · Azure Rm Functionapp Info · Azure Rm Gallery · Azure Rm Gallery Info · Azure Rm Galleryimage · Azure Rm Galleryimage Info · Azure Rm Galleryimageversion · Azure Rm Galleryimageversion Info · Azure Rm Hdinsightcluster · Azure Rm Hdinsightcluster Info · Azure Rm Image · Azure Rm Image Info · Azure Rm Iotdevice · Azure Rm Iotdevice Info · Azure Rm Iotdevicemodule · Azure Rm Iothub · Azure Rm Iothub Info · Azure Rm Iothubconsumergroup · Azure Rm Keyvault · Azure Rm Keyvault Info · Azure Rm Keyvaultkey · Azure Rm Keyvaultkey Info · Azure Rm Keyvaultsecret · Azure Rm Loadbalancer · Azure Rm Loadbalancer Info · Azure Rm Lock · Azure Rm Lock Info · Azure Rm Loganalyticsworkspace · Azure Rm Loganalyticsworkspace Info · Azure Rm Manageddisk · Azure Rm Manageddisk Info · Azure Rm Mariadbconfiguration · Azure Rm Mariadbconfiguration Info · Azure Rm Mariadbdatabase · Azure Rm Mariadbdatabase Info · Azure Rm Mariadbfirewallrule · Azure Rm Mariadbfirewallrule Info · Azure Rm Mariadbserver · Azure Rm Mariadbserver Info · Azure Rm Monitorlogprofile · Azure Rm Mysqlconfiguration · Azure Rm Mysqlconfiguration Info · Azure Rm Mysqldatabase · Azure Rm Mysqldatabase Info · Azure Rm Mysqlfirewallrule · Azure Rm Mysqlfirewallrule Info · Azure Rm Mysqlserver · Azure Rm Mysqlserver Info · Azure Rm Networkinterface · Azure Rm Networkinterface Info · Azure Rm Postgresqlconfiguration · Azure Rm Postgresqlconfiguration Info · Azure Rm Postgresqldatabase · Azure Rm Postgresqldatabase Info · Azure Rm Postgresqlfirewallrule · Azure Rm Postgresqlfirewallrule Info · Azure Rm Postgresqlserver · Azure Rm Postgresqlserver Info · Azure Rm Publicipaddress · Azure Rm Publicipaddress Info · Azure Rm Rediscache · Azure Rm Rediscache Info · Azure Rm Rediscachefirewallrule · Azure Rm Resource · Azure Rm Resource Info · Azure Rm Resourcegroup · Azure Rm Resourcegroup Info · Azure Rm Roleassignment · Azure Rm Roleassignment Info · Azure Rm Roledefinition · Azure Rm Roledefinition Info · Azure Rm Route · Azure Rm Routetable · Azure Rm Routetable Info · Azure Rm Securitygroup · Azure Rm Securitygroup Info · Azure Rm Servicebus · Azure Rm Servicebus Info · Azure Rm Servicebusqueue · Azure Rm Servicebussaspolicy · Azure Rm Servicebustopic · Azure Rm Servicebustopicsubscription · Azure Rm Snapshot · Azure Rm Sqldatabase · Azure Rm Sqldatabase Info · Azure Rm Sqlfirewallrule · Azure Rm Sqlfirewallrule Info · Azure Rm Sqlserver · Azure Rm Sqlserver Info · Azure Rm Storageaccount · Azure Rm Storageaccount Info · Azure Rm Storageblob · Azure Rm Subnet · Azure Rm Subnet Info · Azure Rm Trafficmanagerendpoint · Azure Rm Trafficmanagerendpoint Info · Azure Rm Trafficmanagerprofile · Azure Rm Trafficmanagerprofile Info · Azure Rm Virtualmachine · Azure Rm Virtualmachine Info · Azure Rm Virtualmachineextension · Azure Rm Virtualmachineextension Info · Azure Rm Virtualmachineimage Info · Azure Rm Virtualmachinescaleset · Azure Rm Virtualmachinescaleset Info · Azure Rm Virtualmachinescalesetextension · Azure Rm Virtualmachinescalesetextension Info · Azure Rm Virtualmachinescalesetinstance · Azure Rm Virtualmachinescalesetinstance Info · Azure Rm Virtualnetwork · Azure Rm Virtualnetwork Info · Azure Rm Virtualnetworkgateway · Azure Rm Virtualnetworkpeering · Azure Rm Virtualnetworkpeering Info · Azure Rm Webapp · Azure Rm Webapp Info · Azure Rm Webappslot · Bcf Switch · Beadm · Bearychat · Bigip Apm Acl · Bigip Apm Network Access · Bigip Apm Policy Fetch · Bigip Apm Policy Import · Bigip Appsvcs Extension · Bigip Asm Dos Application · Bigip Asm Policy Fetch · Bigip Asm Policy Import · Bigip Asm Policy Manage · Bigip Asm Policy Server Technology · Bigip Asm Policy Signature Set · Bigip Cli Alias · Bigip Cli Script · Bigip Command · Bigip Config · Bigip Configsync Action · Bigip Data Group · Bigip Device Auth · Bigip Device Auth Ldap · Bigip Device Certificate · Bigip Device Connectivity · Bigip Device Dns · Bigip Device Group · Bigip Device Group Member · Bigip Device Ha Group · Bigip Device Httpd · Bigip Device Info · Bigip Device License · Bigip Device Ntp · Bigip Device Sshd · Bigip Device Syslog · Bigip Device Traffic Group · Bigip Device Trust · Bigip Dns Cache Resolver · Bigip Dns Nameserver · Bigip Dns Resolver · Bigip Dns Zone · Bigip File Copy · Bigip Firewall Address List · Bigip Firewall Dos Profile · Bigip Firewall Dos Vector · Bigip Firewall Global Rules · Bigip Firewall Log Profile · Bigip Firewall Log Profile Network · Bigip Firewall Policy · Bigip Firewall Port List · Bigip Firewall Rule · Bigip Firewall Rule List · Bigip Firewall Schedule · Bigip Gtm Datacenter · Bigip Gtm Global · Bigip Gtm Monitor Bigip · Bigip Gtm Monitor External · Bigip Gtm Monitor Firepass · Bigip Gtm Monitor Http · Bigip Gtm Monitor Https · Bigip Gtm Monitor Tcp · Bigip Gtm Monitor Tcp Half Open · Bigip Gtm Pool · Bigip Gtm Pool Member · Bigip Gtm Server · Bigip Gtm Topology Record · Bigip Gtm Topology Region · Bigip Gtm Virtual Server · Bigip Gtm Wide Ip · Bigip Hostname · Bigip Iapp Service · Bigip Iapp Template · Bigip Ike Peer · Bigip Imish Config · Bigip Ipsec Policy · Bigip Irule · Bigip Log Destination · Bigip Log Publisher · Bigip Lx Package · Bigip Management Route · Bigip Message Routing Peer · Bigip Message Routing Protocol · Bigip Message Routing Route · Bigip Message Routing Router · Bigip Message Routing Transport Config · Bigip Monitor Dns · Bigip Monitor External · Bigip Monitor Gateway Icmp · Bigip Monitor Http · Bigip Monitor Https · Bigip Monitor Ldap · Bigip Monitor Snmp Dca · Bigip Monitor Tcp · Bigip Monitor Tcp Echo · Bigip Monitor Tcp Half Open · Bigip Monitor Udp · Bigip Node · Bigip Partition · Bigip Password Policy · Bigip Policy · Bigip Policy Rule · Bigip Pool · Bigip Pool Member · Bigip Profile Analytics · Bigip Profile Client Ssl · Bigip Profile Dns · Bigip Profile Fastl4 · Bigip Profile Http · Bigip Profile Http Compression · Bigip Profile Http2 · Bigip Profile Oneconnect · Bigip Profile Persistence Cookie · Bigip Profile Persistence Src Addr · Bigip Profile Server Ssl · Bigip Profile Tcp · Bigip Profile Udp · Bigip Provision · Bigip Qkview · Bigip Remote Role · Bigip Remote Syslog · Bigip Remote User · Bigip Routedomain · Bigip Selfip · Bigip Service Policy · Bigip Smtp · Bigip Snat Pool · Bigip Snat Translation · Bigip Snmp · Bigip Snmp Community · Bigip Snmp Trap · Bigip Software Image · Bigip Software Install · Bigip Software Update · Bigip Ssl Certificate · Bigip Ssl Key · Bigip Ssl Ocsp · Bigip Static Route · Bigip Sys Daemon Log Tmm · Bigip Sys Db · Bigip Sys Global · Bigip Timer Policy · Bigip Traffic Selector · Bigip Trunk · Bigip Tunnel · Bigip Ucs · Bigip Ucs Fetch · Bigip User · Bigip Vcmp Guest · Bigip Virtual Address · Bigip Virtual Server · Bigip Vlan · Bigip Wait · Bigiq Application Fasthttp · Bigiq Application Fastl4 Tcp · Bigiq Application Fastl4 Udp · Bigiq Application Http · Bigiq Application Https Offload · Bigiq Application Https Waf · Bigiq Device Discovery · Bigiq Device Info · Bigiq Regkey License · Bigiq Regkey License Assignment · Bigiq Regkey Pool · Bigiq Utility License · Bigiq Utility License Assignment · Bigmon Chain · Bigmon Policy · Bigpanda · Bitbucket Access Key · Bitbucket Pipeline Key Pair · Bitbucket Pipeline Known Host · Bitbucket Pipeline Variable · Blockinfile · Bower · Bundler · Bzr · Campfire · Capabilities · Catapult · Ce Aaa Server · Ce Aaa Server Host · Ce Acl · Ce Acl Advance · Ce Acl Interface · Ce Bfd Global · Ce Bfd Session · Ce Bfd View · Ce Bgp · Ce Bgp Af · Ce Bgp Neighbor · Ce Bgp Neighbor Af · Ce Command · Ce Config · Ce Dldp · Ce Dldp Interface · Ce Eth Trunk · Ce Evpn Bd Vni · Ce Evpn Bgp · Ce Evpn Bgp Rr · Ce Evpn Global · Ce Facts · Ce File Copy · Ce Info Center Debug · Ce Info Center Global · Ce Info Center Log · Ce Info Center Trap · Ce Interface · Ce Interface Ospf · Ce Ip Interface · Ce Link Status · Ce Mlag Config · Ce Mlag Interface · Ce Mtu · Ce Netconf · Ce Netstream Aging · Ce Netstream Export · Ce Netstream Global · Ce Netstream Template · Ce Ntp · Ce Ntp Auth · Ce Ospf · Ce Ospf Vrf · Ce Reboot · Ce Rollback · Ce Sflow · Ce Snmp Community · Ce Snmp Contact · Ce Snmp Location · Ce Snmp Target Host · Ce Snmp Traps · Ce Snmp User · Ce Startup · Ce Static Route · Ce Stp · Ce Switchport · Ce Vlan · Ce Vrf · Ce Vrf Af · Ce Vrf Interface · Ce Vrrp · Ce Vxlan Arp · Ce Vxlan Gateway · Ce Vxlan Global · Ce Vxlan Tunnel · Ce Vxlan Vap · Certificate Complete Chain · Checkpoint Access Layer Facts · Checkpoint Access Rule · Checkpoint Access Rule Facts · Checkpoint Host · Checkpoint Host Facts · Checkpoint Object Facts · Checkpoint Run Script · Checkpoint Session · Checkpoint Task Facts · Circonus Annotation · Cisco Spark · Clc Aa Policy · Clc Alert Policy · Clc Blueprint Package · Clc Firewall Policy · Clc Group · Clc Loadbalancer · Clc Modify Server · Clc Publicip · Clc Server · Clc Server Snapshot · Cli Command · Cli Config · Cloud Init Data Facts · Cloudflare Dns · Cloudformation · Cloudformation Info · Cloudformation Stack Set · Cloudfront Distribution · Cloudfront Info · Cloudfront Invalidation · Cloudfront Origin Access Identity · Cloudscale Floating Ip · Cloudscale Server · Cloudscale Server Group · Cloudscale Volume · Cloudtrail · Cloudwatchevent Rule · Cloudwatchlogs Log Group · Cloudwatchlogs Log Group Info · Cnos Backup · Cnos Banner · Cnos Bgp · Cnos Command · Cnos Conditional Command · Cnos Conditional Template · Cnos Config · Cnos Factory · Cnos Facts · Cnos Image · Cnos Interface · Cnos L2 Interface · Cnos L3 Interface · Cnos Linkagg · Cnos Lldp · Cnos Logging · Cnos Reload · Cnos Rollback · Cnos Save · Cnos Showrun · Cnos Static Route · Cnos System · Cnos Template · Cnos User · Cnos Vlag · Cnos Vlan · Cnos Vrf · Cobbler Sync · Cobbler System · Command · Composer · Consul · Consul Acl · Consul Kv · Consul Session · Copy · Cp Mgmt Access Layer · Cp Mgmt Access Layer Facts · Cp Mgmt Access Role · Cp Mgmt Access Role Facts · Cp Mgmt Access Rule · Cp Mgmt Access Rule Facts · Cp Mgmt Address Range · Cp Mgmt Address Range Facts · Cp Mgmt Administrator · Cp Mgmt Administrator Facts · Cp Mgmt Application Site · Cp Mgmt Application Site Category · Cp Mgmt Application Site Category Facts · Cp Mgmt Application Site Facts · Cp Mgmt Application Site Group · Cp Mgmt Application Site Group Facts · Cp Mgmt Assign Global Assignment · Cp Mgmt Discard · Cp Mgmt Dns Domain · Cp Mgmt Dns Domain Facts · Cp Mgmt Dynamic Object · Cp Mgmt Dynamic Object Facts · Cp Mgmt Exception Group · Cp Mgmt Exception Group Facts · Cp Mgmt Global Assignment · Cp Mgmt Global Assignment Facts · Cp Mgmt Group · Cp Mgmt Group Facts · Cp Mgmt Group With Exclusion · Cp Mgmt Group With Exclusion Facts · Cp Mgmt Host · Cp Mgmt Host Facts · Cp Mgmt Install Policy · Cp Mgmt Mds Facts · Cp Mgmt Multicast Address Range · Cp Mgmt Multicast Address Range Facts · Cp Mgmt Network · Cp Mgmt Network Facts · Cp Mgmt Package · Cp Mgmt Package Facts · Cp Mgmt Publish · Cp Mgmt Put File · Cp Mgmt Run Ips Update · Cp Mgmt Run Script · Cp Mgmt Security Zone · Cp Mgmt Security Zone Facts · Cp Mgmt Service Dce Rpc · Cp Mgmt Service Dce Rpc Facts · Cp Mgmt Service Group · Cp Mgmt Service Group Facts · Cp Mgmt Service Icmp · Cp Mgmt Service Icmp Facts · Cp Mgmt Service Icmp6 · Cp Mgmt Service Icmp6 Facts · Cp Mgmt Service Other · Cp Mgmt Service Other Facts · Cp Mgmt Service Rpc · Cp Mgmt Service Rpc Facts · Cp Mgmt Service Sctp · Cp Mgmt Service Sctp Facts · Cp Mgmt Service Tcp · Cp Mgmt Service Tcp Facts · Cp Mgmt Service Udp · Cp Mgmt Service Udp Facts · Cp Mgmt Session Facts · Cp Mgmt Simple Gateway · Cp Mgmt Simple Gateway Facts · Cp Mgmt Tag · Cp Mgmt Tag Facts · Cp Mgmt Threat Exception · Cp Mgmt Threat Exception Facts · Cp Mgmt Threat Indicator · Cp Mgmt Threat Indicator Facts · Cp Mgmt Threat Layer · Cp Mgmt Threat Layer Facts · Cp Mgmt Threat Profile · Cp Mgmt Threat Profile Facts · Cp Mgmt Threat Protection Override · Cp Mgmt Threat Rule · Cp Mgmt Threat Rule Facts · Cp Mgmt Time · Cp Mgmt Time Facts · Cp Mgmt Verify Policy · Cp Mgmt Vpn Community Meshed · Cp Mgmt Vpn Community Meshed Facts · Cp Mgmt Vpn Community Star · Cp Mgmt Vpn Community Star Facts · Cp Mgmt Wildcard · Cp Mgmt Wildcard Facts · Cp Publish · Cpanm · Cpm Plugconfig · Cpm Plugcontrol · Cpm Serial Port Config · Cpm Serial Port Info · Cpm User · Cron · Cronvar · Crypttab · Cs Account · Cs Affinitygroup · Cs Cluster · Cs Configuration · Cs Disk Offering · Cs Domain · Cs Facts · Cs Firewall · Cs Host · Cs Image Store · Cs Instance · Cs Instance Info · Cs Instance Nic · Cs Instance Nic Secondaryip · Cs Instance Password Reset · Cs Instancegroup · Cs Ip Address · Cs Iso · Cs Loadbalancer Rule · Cs Loadbalancer Rule Member · Cs Network · Cs Network Acl · Cs Network Acl Rule · Cs Network Offering · Cs Physical Network · Cs Pod · Cs Portforward · Cs Project · Cs Region · Cs Resourcelimit · Cs Role · Cs Role Permission · Cs Router · Cs Securitygroup · Cs Securitygroup Rule · Cs Service Offering · Cs Snapshot Policy · Cs Sshkeypair · Cs Staticnat · Cs Storage Pool · Cs Template · Cs Traffic Type · Cs User · Cs Vlan Ip Range · Cs Vmsnapshot · Cs Volume · Cs Vpc · Cs Vpc Offering · Cs Vpn Connection · Cs Vpn Customer Gateway · Cs Vpn Gateway · Cs Zone · Cs Zone Info · Cv Server Provision · Cyberark Authentication · Cyberark User · Data Pipeline · Datadog Event · Datadog Monitor · Dconf · Debconf · Debug · Dellos10 Command · Dellos10 Config · Dellos10 Facts · Dellos6 Command · Dellos6 Config · Dellos6 Facts · Dellos9 Command · Dellos9 Config · Dellos9 Facts · Deploy Helper · Digital Ocean Account Info · Digital Ocean Block Storage · Digital Ocean Certificate · Digital Ocean Certificate Info · Digital Ocean Domain · Digital Ocean Domain Info · Digital Ocean Droplet · Digital Ocean Firewall Info · Digital Ocean Floating Ip · Digital Ocean Floating Ip Info · Digital Ocean Image Info · Digital Ocean Load Balancer Info · Digital Ocean Region Info · Digital Ocean Size Info · Digital Ocean Snapshot Info · Digital Ocean Sshkey · Digital Ocean Sshkey Info · Digital Ocean Tag · Digital Ocean Tag Info · Digital Ocean Volume Info · Dimensiondata Network · Dimensiondata Vlan · Django Manage · Dladm Etherstub · Dladm Iptun · Dladm Linkprop · Dladm Vlan · Dladm Vnic · Dms Endpoint · Dms Replication Subnet Group · Dnf · Dnsimple · Dnsmadeeasy · Docker Compose · Docker Config · Docker Container · Docker Container Info · Docker Host Info · Docker Image · Docker Image Info · Docker Login · Docker Network · Docker Network Info · Docker Node · Docker Node Info · Docker Prune · Docker Secret · Docker Stack · Docker Swarm · Docker Swarm Info · Docker Swarm Service · Docker Swarm Service Info · Docker Volume · Docker Volume Info · Dpkg Selections · Dynamodb Table · Dynamodb Ttl · Easy Install · Ec 2 · Ec2 Ami · Ec2 Ami Copy · Ec2 Ami Info · Ec2 Asg · Ec2 Asg Info · Ec2 Asg Lifecycle Hook · Ec2 Customer Gateway · Ec2 Customer Gateway Info · Ec2 Eip · Ec2 Eip Info · Ec2 Elb · Ec2 Elb Info · Ec2 Elb Lb · Ec2 Eni · Ec2 Eni Info · Ec2 Group · Ec2 Group Info · Ec2 Instance · Ec2 Instance Info · Ec2 Key · Ec2 Launch Template · Ec2 Lc · Ec2 Lc Find · Ec2 Lc Info · Ec2 Metadata Facts · Ec2 Metric Alarm · Ec2 Placement Group · Ec2 Placement Group Info · Ec2 Scaling Policy · Ec2 Snapshot · Ec2 Snapshot Copy · Ec2 Snapshot Info · Ec2 Tag · Ec2 Transit Gateway · Ec2 Transit Gateway Info · Ec2 Vol · Ec2 Vol Info · Ec2 Vpc Dhcp Option · Ec2 Vpc Dhcp Option Info · Ec2 Vpc Egress Igw · Ec2 Vpc Endpoint · Ec2 Vpc Endpoint Info · Ec2 Vpc Igw · Ec2 Vpc Igw Info · Ec2 Vpc Nacl · Ec2 Vpc Nacl Info · Ec2 Vpc Nat Gateway · Ec2 Vpc Nat Gateway Info · Ec2 Vpc Net · Ec2 Vpc Net Info · Ec2 Vpc Peer · Ec2 Vpc Peering Info · Ec2 Vpc Route Table · Ec2 Vpc Route Table Info · Ec2 Vpc Subnet · Ec2 Vpc Subnet Info · Ec2 Vpc Vgw · Ec2 Vpc Vgw Info · Ec2 Vpc Vpn · Ec2 Vpc Vpn Info · Ec2 Win Password · Ecs Attribute · Ecs Certificate · Ecs Cluster · Ecs Ecr · Ecs Service · Ecs Service Info · Ecs Task · Ecs Taskdefinition · Ecs Taskdefinition Info · Edgeos Command · Edgeos Config · Edgeos Facts · Edgeswitch Facts · Edgeswitch Vlan · Efs · Efs Info · Ejabberd User · Elasticache · Elasticache Info · Elasticache Parameter Group · Elasticache Snapshot · Elasticache Subnet Group · Elasticsearch Plugin · Elb Application Lb · Elb Application Lb Info · Elb Classic Lb · Elb Classic Lb Info · Elb Instance · Elb Network Lb · Elb Target · Elb Target Group · Elb Target Group Info · Elb Target Info · Emc Vnx Sg Member · Enos Command · Enos Config · Enos Facts · Eos Banner · Eos Bgp · Eos Command · Eos Config · Eos Eapi · Eos Facts · Eos Interfaces · Eos L2 Interfaces · Eos L3 Interfaces · Eos Lacp · Eos Lacp Interfaces · Eos Lag Interfaces · Eos Lldp · Eos Lldp Global · Eos Lldp Interfaces · Eos Logging · Eos Static Route · Eos System · Eos User · Eos Vlans · Eos Vrf · Eric Eccli Command · Etcd 3 · Execute Lambda · Exo Dns Domain · Exo Dns Record · Exos Command · Exos Config · Exos Facts · Exos Lldp Global · Expect · Facter · Fail · Faz Device · Fetch · File · Filesystem · Find · Firewalld · Flatpak · Flatpak Remote · Flowadm · Flowdock · Fmgr Device · Fmgr Device Config · Fmgr Device Group · Fmgr Device Provision Template · Fmgr Fwobj Address · Fmgr Fwobj Ippool · Fmgr Fwobj Ippool6 · Fmgr Fwobj Service · Fmgr Fwobj Vip · Fmgr Fwpol Ipv4 · Fmgr Fwpol Package · Fmgr Ha · Fmgr Provisioning · Fmgr Query · Fmgr Script · Fmgr Secprof Appctrl · Fmgr Secprof Av · Fmgr Secprof Dns · Fmgr Secprof Ips · Fmgr Secprof Profile Group · Fmgr Secprof Proxy · Fmgr Secprof Spam · Fmgr Secprof Ssl Ssh · Fmgr Secprof Voip · Fmgr Secprof Waf · Fmgr Secprof Wanopt · Fmgr Secprof Web · Fortios Address · Fortios Alertemail Setting · Fortios Antivirus Heuristic · Fortios Antivirus Profile · Fortios Antivirus Quarantine · Fortios Antivirus Settings · Fortios Application Custom · Fortios Application Group · Fortios Application List · Fortios Application Name · Fortios Application Rule Settings · Fortios Authentication Rule · Fortios Authentication Scheme · Fortios Authentication Setting · Fortios Config · Fortios Dlp Filepattern · Fortios Dlp Fp Doc Source · Fortios Dlp Fp Sensitivity · Fortios Dlp Sensor · Fortios Dlp Settings · Fortios Dnsfilter Domain Filter · Fortios Dnsfilter Profile · Fortios Endpoint Control Client · Fortios Endpoint Control Forticlient Ems · Fortios Endpoint Control Forticlient Registration Sync · Fortios Endpoint Control Profile · Fortios Endpoint Control Settings · Fortios Extender Controller Extender · Fortios Facts · Fortios Firewall Address · Fortios Firewall Address6 · Fortios Firewall Address6 Template · Fortios Firewall Addrgrp · Fortios Firewall Addrgrp6 · Fortios Firewall Auth Portal · Fortios Firewall Central Snat Map · Fortios Firewall Dnstranslation · Fortios Firewall DoS Policy · Fortios Firewall DoS Policy6 · Fortios Firewall Identity Based Route · Fortios Firewall Interface Policy · Fortios Firewall Interface Policy6 · Fortios Firewall Internet Service · Fortios Firewall Internet Service Custom · Fortios Firewall Internet Service Group · Fortios Firewall Ip Translation · Fortios Firewall Ipmacbinding Setting · Fortios Firewall Ipmacbinding Table · Fortios Firewall Ippool · Fortios Firewall Ippool6 · Fortios Firewall Ipv6 Eh Filter · Fortios Firewall Ldb Monitor · Fortios Firewall Local In Policy · Fortios Firewall Local In Policy6 · Fortios Firewall Multicast Address · Fortios Firewall Multicast Address6 · Fortios Firewall Multicast Policy · Fortios Firewall Multicast Policy6 · Fortios Firewall Policy · Fortios Firewall Policy46 · Fortios Firewall Policy6 · Fortios Firewall Policy64 · Fortios Firewall Profile Group · Fortios Firewall Profile Protocol Options · Fortios Firewall Proxy Address · Fortios Firewall Proxy Addrgrp · Fortios Firewall Proxy Policy · Fortios Firewall Schedule Group · Fortios Firewall Schedule Onetime · Fortios Firewall Schedule Recurring · Fortios Firewall Service Category · Fortios Firewall Service Custom · Fortios Firewall Service Group · Fortios Firewall Shaper Per Ip Shaper · Fortios Firewall Shaper Traffic Shaper · Fortios Firewall Shaping Policy · Fortios Firewall Shaping Profile · Fortios Firewall Sniffer · Fortios Firewall Ssh Host Key · Fortios Firewall Ssh Local Ca · Fortios Firewall Ssh Local Key · Fortios Firewall Ssh Setting · Fortios Firewall Ssl Server · Fortios Firewall Ssl Setting · Fortios Firewall Ssl Ssh Profile · Fortios Firewall Ttl Policy · Fortios Firewall Vip · Fortios Firewall Vip46 · Fortios Firewall Vip6 · Fortios Firewall Vip64 · Fortios Firewall Vipgrp · Fortios Firewall Vipgrp46 · Fortios Firewall Vipgrp6 · Fortios Firewall Vipgrp64 · Fortios Firewall Wildcard Fqdn Custom · Fortios Firewall Wildcard Fqdn Group · Fortios Ftp Proxy Explicit · Fortios Icap Profile · Fortios Icap Server · Fortios Ips Custom · Fortios Ips Decoder · Fortios Ips Global · Fortios Ips Rule · Fortios Ips Rule Settings · Fortios Ips Sensor · Fortios Ips Settings · Fortios Ipv4 Policy · Fortios Log Custom Field · Fortios Log Disk Filter · Fortios Log Disk Setting · Fortios Log Eventfilter · Fortios Log Fortianalyzer Filter · Fortios Log Fortianalyzer Override Filter · Fortios Log Fortianalyzer Override Setting · Fortios Log Fortianalyzer Setting · Fortios Log Fortianalyzer2 Filter · Fortios Log Fortianalyzer2 Setting · Fortios Log Fortianalyzer3 Filter · Fortios Log Fortianalyzer3 Setting · Fortios Log Fortiguard Filter · Fortios Log Fortiguard Override Filter · Fortios Log Fortiguard Override Setting · Fortios Log Fortiguard Setting · Fortios Log Gui Display · Fortios Log Memory Filter · Fortios Log Memory Global Setting · Fortios Log Memory Setting · Fortios Log Null Device Filter · Fortios Log Null Device Setting · Fortios Log Setting · Fortios Log Syslogd Filter · Fortios Log Syslogd Override Filter · Fortios Log Syslogd Override Setting · Fortios Log Syslogd Setting · Fortios Log Syslogd2 Filter · Fortios Log Syslogd2 Setting · Fortios Log Syslogd3 Filter · Fortios Log Syslogd3 Setting · Fortios Log Syslogd4 Filter · Fortios Log Syslogd4 Setting · Fortios Log Threat Weight · Fortios Log Webtrends Filter · Fortios Log Webtrends Setting · Fortios Report Chart · Fortios Report Dataset · Fortios Report Layout · Fortios Report Setting · Fortios Report Style · Fortios Report Theme · Fortios Router Access List · Fortios Router Access List6 · Fortios Router Aspath List · Fortios Router Auth Path · Fortios Router Bfd · Fortios Router Bfd6 · Fortios Router Bgp · Fortios Router Community List · Fortios Router Isis · Fortios Router Key Chain · Fortios Router Multicast · Fortios Router Multicast Flow · Fortios Router Multicast6 · Fortios Router Ospf · Fortios Router Ospf6 · Fortios Router Policy · Fortios Router Policy6 · Fortios Router Prefix List · Fortios Router Prefix List6 · Fortios Router Rip · Fortios Router Ripng · Fortios Router Route Map · Fortios Router Setting · Fortios Router Static · Fortios Router Static6 · Fortios Spamfilter Bwl · Fortios Spamfilter Bword · Fortios Spamfilter Dnsbl · Fortios Spamfilter Fortishield · Fortios Spamfilter Iptrust · Fortios Spamfilter Mheader · Fortios Spamfilter Options · Fortios Spamfilter Profile · Fortios Ssh Filter Profile · Fortios Switch Controller 802 1X Settings · Fortios Switch Controller Custom Command · Fortios Switch Controller Global · Fortios Switch Controller Igmp Snooping · Fortios Switch Controller Lldp Profile · Fortios Switch Controller Lldp Settings · Fortios Switch Controller Mac Sync Settings · Fortios Switch Controller Managed Switch · Fortios Switch Controller Network Monitor Settings · Fortios Switch Controller Qos Dot1p Map · Fortios Switch Controller Qos Ip Dscp Map · Fortios Switch Controller Qos Qos Policy · Fortios Switch Controller Qos Queue Policy · Fortios Switch Controller Quarantine · Fortios Switch Controller Security Policy 802 1X · Fortios Switch Controller Security Policy Captive Portal · Fortios Switch Controller Sflow · Fortios Switch Controller Storm Control · Fortios Switch Controller Stp Settings · Fortios Switch Controller Switch Group · Fortios Switch Controller Switch Interface Tag · Fortios Switch Controller Switch Log · Fortios Switch Controller Switch Profile · Fortios Switch Controller System · Fortios Switch Controller Virtual Port Pool · Fortios Switch Controller Vlan · Fortios System Accprofile · Fortios System Admin · Fortios System Affinity Interrupt · Fortios System Affinity Packet Redistribution · Fortios System Alarm · Fortios System Alias · Fortios System Api User · Fortios System Arp Table · Fortios System Auto Install · Fortios System Auto Script · Fortios System Automation Action · Fortios System Automation Destination · Fortios System Automation Stitch · Fortios System Automation Trigger · Fortios System Autoupdate Push Update · Fortios System Autoupdate Schedule · Fortios System Autoupdate Tunneling · Fortios System Central Management · Fortios System Cluster Sync · Fortios System Console · Fortios System Csf · Fortios System Custom Language · Fortios System Ddns · Fortios System Dedicated Mgmt · Fortios System Dhcp Server · Fortios System Dhcp6 Server · Fortios System Dns · Fortios System Dns Database · Fortios System Dns Server · Fortios System Dscp Based Priority · Fortios System Email Server · Fortios System External Resource · Fortios System Fips Cc · Fortios System Firmware Upgrade · Fortios System Fm · Fortios System Fortiguard · Fortios System Fortimanager · Fortios System Fortisandbox · Fortios System Fsso Polling · Fortios System Ftm Push · Fortios System Geoip Override · Fortios System Global · Fortios System Gre Tunnel · Fortios System Ha · Fortios System Ha Monitor · Fortios System Interface · Fortios System Ipip Tunnel · Fortios System Ips Urlfilter Dns · Fortios System Ips Urlfilter Dns6 · Fortios System Ipv6 Neighbor Cache · Fortios System Ipv6 Tunnel · Fortios System Link Monitor · Fortios System Mac Address Table · Fortios System Management Tunnel · Fortios System Mobile Tunnel · Fortios System Nat64 · Fortios System Nd Proxy · Fortios System Netflow · Fortios System Network Visibility · Fortios System Ntp · Fortios System Object Tagging · Fortios System Password Policy · Fortios System Password Policy Guest Admin · Fortios System Pppoe Interface · Fortios System Probe Response · Fortios System Proxy Arp · Fortios System Replacemsg Admin · Fortios System Replacemsg Alertmail · Fortios System Replacemsg Auth · Fortios System Replacemsg Device Detection Portal · Fortios System Replacemsg Ec · Fortios System Replacemsg Fortiguard Wf · Fortios System Replacemsg Ftp · Fortios System Replacemsg Group · Fortios System Replacemsg Http · Fortios System Replacemsg Icap · Fortios System Replacemsg Image · Fortios System Replacemsg Mail · Fortios System Replacemsg Nac Quar · Fortios System Replacemsg Nntp · Fortios System Replacemsg Spam · Fortios System Replacemsg Sslvpn · Fortios System Replacemsg Traffic Quota · Fortios System Replacemsg Utm · Fortios System Replacemsg Webproxy · Fortios System Resource Limits · Fortios System Sdn Connector · Fortios System Session Helper · Fortios System Session Ttl · Fortios System Settings · Fortios System Sflow · Fortios System Sit Tunnel · Fortios System Sms Server · Fortios System Snmp Community · Fortios System Snmp Sysinfo · Fortios System Snmp User · Fortios System Storage · Fortios System Switch Interface · Fortios System Tos Based Priority · Fortios System Vdom · Fortios System Vdom Dns · Fortios System Vdom Exception · Fortios System Vdom Link · Fortios System Vdom Netflow · Fortios System Vdom Property · Fortios System Vdom Radius Server · Fortios System Vdom Sflow · Fortios System Virtual Wan Link · Fortios System Virtual Wire Pair · Fortios System Vxlan · Fortios System Wccp · Fortios System Zone · Fortios User Adgrp · Fortios User Device · Fortios User Device Access List · Fortios User Device Category · Fortios User Device Group · Fortios User Domain Controller · Fortios User Fortitoken · Fortios User Fsso · Fortios User Fsso Polling · Fortios User Group · Fortios User Krb Keytab · Fortios User Ldap · Fortios User Local · Fortios User Password Policy · Fortios User Peer · Fortios User Peergrp · Fortios User Pop3 · Fortios User Quarantine · Fortios User Radius · Fortios User Security Exempt List · Fortios User Setting · Fortios User Tacacsplus · Fortios Voip Profile · Fortios Vpn Certificate Ca · Fortios Vpn Certificate Crl · Fortios Vpn Certificate Local · Fortios Vpn Certificate Ocsp Server · Fortios Vpn Certificate Remote · Fortios Vpn Certificate Setting · Fortios Vpn Ipsec Concentrator · Fortios Vpn Ipsec Forticlient · Fortios Vpn Ipsec Manualkey · Fortios Vpn Ipsec Manualkey Interface · Fortios Vpn Ipsec Phase1 · Fortios Vpn Ipsec Phase1 Interface · Fortios Vpn Ipsec Phase2 · Fortios Vpn Ipsec Phase2 Interface · Fortios Vpn L2tp · Fortios Vpn Pptp · Fortios Vpn Ssl Settings · Fortios Vpn Ssl Web Host Check Software · Fortios Vpn Ssl Web Portal · Fortios Vpn Ssl Web Realm · Fortios Vpn Ssl Web User Bookmark · Fortios Vpn Ssl Web User Group Bookmark · Fortios Waf Main Class · Fortios Waf Profile · Fortios Waf Signature · Fortios Waf Sub Class · Fortios Wanopt Auth Group · Fortios Wanopt Cache Service · Fortios Wanopt Content Delivery Network Rule · Fortios Wanopt Peer · Fortios Wanopt Profile · Fortios Wanopt Remote Storage · Fortios Wanopt Settings · Fortios Wanopt Webcache · Fortios Web Proxy Debug Url · Fortios Web Proxy Explicit · Fortios Web Proxy Forward Server · Fortios Web Proxy Forward Server Group · Fortios Web Proxy Global · Fortios Web Proxy Profile · Fortios Web Proxy Url Match · Fortios Web Proxy Wisp · Fortios Webfilter · Fortios Webfilter Content · Fortios Webfilter Content Header · Fortios Webfilter Fortiguard · Fortios Webfilter Ftgd Local Cat · Fortios Webfilter Ftgd Local Rating · Fortios Webfilter Ips Urlfilter Cache Setting · Fortios Webfilter Ips Urlfilter Setting · Fortios Webfilter Ips Urlfilter Setting6 · Fortios Webfilter Override · Fortios Webfilter Profile · Fortios Webfilter Search Engine · Fortios Webfilter Urlfilter · Fortios Wireless Controller Ap Status · Fortios Wireless Controller Ble Profile · Fortios Wireless Controller Bonjour Profile · Fortios Wireless Controller Global · Fortios Wireless Controller Hotspot20 Anqp 3gpp Cellular · Fortios Wireless Controller Hotspot20 Anqp Ip Address Type · Fortios Wireless Controller Hotspot20 Anqp Nai Realm · Fortios Wireless Controller Hotspot20 Anqp Network Auth Type · Fortios Wireless Controller Hotspot20 Anqp Roaming Consortium · Fortios Wireless Controller Hotspot20 Anqp Venue Name · Fortios Wireless Controller Hotspot20 H2qp Conn Capability · Fortios Wireless Controller Hotspot20 H2qp Operator Name · Fortios Wireless Controller Hotspot20 H2qp Osu Provider · Fortios Wireless Controller Hotspot20 H2qp Wan Metric · Fortios Wireless Controller Hotspot20 Hs Profile · Fortios Wireless Controller Hotspot20 Icon · Fortios Wireless Controller Hotspot20 Qos Map · Fortios Wireless Controller Inter Controller · Fortios Wireless Controller Qos Profile · Fortios Wireless Controller Setting · Fortios Wireless Controller Timers · Fortios Wireless Controller Utm Profile · Fortios Wireless Controller Vap · Fortios Wireless Controller Vap Group · Fortios Wireless Controller Wids Profile · Fortios Wireless Controller Wtp · Fortios Wireless Controller Wtp Group · Fortios Wireless Controller Wtp Profile · Frr Bgp · Frr Facts · Ftd Configuration · Ftd File Download · Ftd File Upload · Ftd Install · Gather Facts · Gc Storage · Gce Eip · Gce Img · Gce Instance Template · Gce Labels · Gce Lb · Gce Mig · Gce Net · Gce Pd · Gce Snapshot · Gce Tag · Gconftool 2 · Gcp Appengine Firewall Rule · Gcp Appengine Firewall Rule Info · Gcp Bigquery Dataset · Gcp Bigquery Dataset Info · Gcp Bigquery Table · Gcp Bigquery Table Info · Gcp Cloudbuild Trigger · Gcp Cloudbuild Trigger Info · Gcp Cloudfunctions Cloud Function · Gcp Cloudfunctions Cloud Function Info · Gcp Cloudscheduler Job · Gcp Cloudscheduler Job Info · Gcp Cloudtasks Queue · Gcp Cloudtasks Queue Info · Gcp Compute Address · Gcp Compute Address Info · Gcp Compute Autoscaler · Gcp Compute Autoscaler Info · Gcp Compute Backend Bucket · Gcp Compute Backend Bucket Info · Gcp Compute Backend Service · Gcp Compute Backend Service Info · Gcp Compute Disk · Gcp Compute Disk Info · Gcp Compute Firewall · Gcp Compute Firewall Info · Gcp Compute Forwarding Rule · Gcp Compute Forwarding Rule Info · Gcp Compute Global Address · Gcp Compute Global Address Info · Gcp Compute Global Forwarding Rule · Gcp Compute Global Forwarding Rule Info · Gcp Compute Health Check · Gcp Compute Health Check Info · Gcp Compute Http Health Check · Gcp Compute Http Health Check Info · Gcp Compute Https Health Check · Gcp Compute Https Health Check Info · Gcp Compute Image · Gcp Compute Image Info · Gcp Compute Instance · Gcp Compute Instance Group · Gcp Compute Instance Group Info · Gcp Compute Instance Group Manager · Gcp Compute Instance Group Manager Info · Gcp Compute Instance Info · Gcp Compute Instance Template · Gcp Compute Instance Template Info · Gcp Compute Interconnect Attachment · Gcp Compute Interconnect Attachment Info · Gcp Compute Network · Gcp Compute Network Info · Gcp Compute Region Disk · Gcp Compute Region Disk Info · Gcp Compute Route · Gcp Compute Route Info · Gcp Compute Router · Gcp Compute Router Info · Gcp Compute Snapshot · Gcp Compute Snapshot Info · Gcp Compute Ssl Certificate · Gcp Compute Ssl Certificate Info · Gcp Compute Ssl Policy · Gcp Compute Ssl Policy Info · Gcp Compute Subnetwork · Gcp Compute Subnetwork Info · Gcp Compute Target Http Proxy · Gcp Compute Target Http Proxy Info · Gcp Compute Target Https Proxy · Gcp Compute Target Https Proxy Info · Gcp Compute Target Pool · Gcp Compute Target Pool Info · Gcp Compute Target Ssl Proxy · Gcp Compute Target Ssl Proxy Info · Gcp Compute Target Tcp Proxy · Gcp Compute Target Tcp Proxy Info · Gcp Compute Target Vpn Gateway · Gcp Compute Target Vpn Gateway Info · Gcp Compute Url Map · Gcp Compute Url Map Info · Gcp Compute Vpn Tunnel · Gcp Compute Vpn Tunnel Info · Gcp Container Cluster · Gcp Container Cluster Info · Gcp Container Node Pool · Gcp Container Node Pool Info · Gcp Dns Managed Zone · Gcp Dns Managed Zone Info · Gcp Dns Resource Record Set · Gcp Dns Resource Record Set Info · Gcp Filestore Instance · Gcp Filestore Instance Info · Gcp Iam Role · Gcp Iam Role Info · Gcp Iam Service Account · Gcp Iam Service Account Info · Gcp Iam Service Account Key · Gcp Kms Crypto Key · Gcp Kms Crypto Key Info · Gcp Kms Key Ring · Gcp Kms Key Ring Info · Gcp Mlengine Model · Gcp Mlengine Model Info · Gcp Mlengine Version · Gcp Mlengine Version Info · Gcp Pubsub Subscription · Gcp Pubsub Subscription Info · Gcp Pubsub Topic · Gcp Pubsub Topic Info · Gcp Redis Instance · Gcp Redis Instance Info · Gcp Resourcemanager Project · Gcp Resourcemanager Project Info · Gcp Sourcerepo Repository · Gcp Sourcerepo Repository Info · Gcp Spanner Database · Gcp Spanner Database Info · Gcp Spanner Instance · Gcp Spanner Instance Info · Gcp Sql Database · Gcp Sql Database Info · Gcp Sql Instance · Gcp Sql Instance Info · Gcp Sql User · Gcp Sql User Info · Gcp Storage Bucket · Gcp Storage Bucket Access Control · Gcp Storage Object · Gcp Tpu Node · Gcp Tpu Node Info · Gcpubsub · Gcpubsub Info · Gem · Get Certificate · Get Url · Getent · Git · Git Config · Github Deploy Key · Github Issue · Github Key · Github Release · Github Webhook · Github Webhook Info · Gitlab Deploy Key · Gitlab Group · Gitlab Hook · Gitlab Project · Gitlab Project Variable · Gitlab Runner · Gitlab User · Gluster Heal Info · Gluster Peer · Gluster Volume · Grafana Dashboard · Grafana Datasource · Grafana Plugin · Group · Group By · Grove · Gunicorn · Haproxy · Hcloud Datacenter Info · Hcloud Floating Ip Info · Hcloud Image Info · Hcloud Location Info · Hcloud Network · Hcloud Network Info · Hcloud Rdns · Hcloud Route · Hcloud Server · Hcloud Server Info · Hcloud Server Network · Hcloud Server Type Info · Hcloud Ssh Key · Hcloud Ssh Key Info · Hcloud Subnetwork · Hcloud Volume · Hcloud Volume Info · Helm · Heroku Collaborator · Hetzner Failover Ip · Hetzner Failover Ip Info · Hg · Hipchat · Homebrew · Homebrew Cask · Homebrew Tap · Honeybadger Deployment · Hostname · Hpilo Boot · Hpilo Info · Hponcfg · Htpasswd · Hwc Network Vpc · Hwc Smn Topic · Iam · Iam Cert · Iam Group · Iam Managed Policy · Iam Mfa Device Info · Iam Password Policy · Iam Policy · Iam Role · Iam Role Info · Iam Server Certificate Info · Iam User · Iap Start Workflow · Iap Token · Ibm Sa Domain · Ibm Sa Host · Ibm Sa Host Ports · Ibm Sa Pool · Ibm Sa Vol · Ibm Sa Vol Map · Icinga2 Feature · Icinga2 Host · Icx Banner · Icx Command · Icx Config · Icx Copy · Icx Facts · Icx Interface · Icx L3 Interface · Icx Linkagg · Icx Lldp · Icx Logging · Icx Ping · Icx Static Route · Icx System · Icx User · Icx Vlan · Idrac Firmware · Idrac Redfish Command · Idrac Redfish Config · Idrac Redfish Info · Idrac Server Config Profile · Ig Config · Ig Unit Information · Imc Rest · Imgadm · Import Playbook · Import Role · Import Tasks · Include · Include Role · Include Tasks · Include Vars · Infini Export · Infini Export Client · Infini Fs · Infini Host · Infini Pool · Infini Vol · Infinity · Influxdb Database · Influxdb Query · Influxdb Retention Policy · Influxdb User · Influxdb Write · Ini File · Installp · Interfaces File · Intersight Info · Intersight Rest Api · Ios Banner · Ios Bgp · Ios Command · Ios Config · Ios Facts · Ios Interfaces · Ios L2 Interfaces · Ios L3 Interfaces · Ios Lacp · Ios Lacp Interfaces · Ios Lag Interfaces · Ios Linkagg · Ios Lldp · Ios Lldp Global · Ios Lldp Interfaces · Ios Logging · Ios Ntp · Ios Ping · Ios Static Route · Ios System · Ios User · Ios Vlans · Ios Vrf · Iosxr Banner · Iosxr Bgp · Iosxr Command · Iosxr Config · Iosxr Facts · Iosxr Interfaces · Iosxr L2 Interfaces · Iosxr L3 Interfaces · Iosxr Lacp · Iosxr Lacp Interfaces · Iosxr Lag Interfaces · Iosxr Lldp Global · Iosxr Lldp Interfaces · Iosxr Logging · Iosxr Netconf · Iosxr System · Iosxr User · Ip Netns · Ipa Config · Ipa Dnsrecord · Ipa Dnszone · Ipa Group · Ipa Hbacrule · Ipa Host · Ipa Hostgroup · Ipa Role · Ipa Service · Ipa Subca · Ipa Sudocmd · Ipa Sudocmdgroup · Ipa Sudorule · Ipa User · Ipa Vault · Ipadm Addr · Ipadm Addrprop · Ipadm If · Ipadm Ifprop · Ipadm Prop · Ipify Facts · Ipinfoio Facts · Ipmi Boot · Ipmi Power · Iptables · Irc · Ironware Command · Ironware Config · Ironware Facts · Iso Extract · Jabber · Java Cert · Java Keystore · Jboss · Jenkins Job · Jenkins Job Info · Jenkins Plugin · Jenkins Script · Jira · Junos Banner · Junos Command · Junos Config · Junos Facts · Junos Interfaces · Junos L2 Interfaces · Junos L3 Interfaces · Junos Lacp · Junos Lacp Interfaces · Junos Lag Interfaces · Junos Lldp Global · Junos Lldp Interfaces · Junos Logging · Junos Netconf · Junos Package · Junos Ping · Junos Rpc · Junos Scp · Junos Static Route · Junos System · Junos User · Junos Vlans · Junos Vrf · K 8 S · K8s Auth · K8s Info · K8s Scale · K8s Service · Kernel Blacklist · Keycloak Client · Keycloak Clienttemplate · Keycloak Group · Kibana Plugin · Kinesis Stream · Known Hosts · Kubevirt Cdi Upload · Kubevirt Preset · Kubevirt Pvc · Kubevirt Rs · Kubevirt Template · Kubevirt Vm · Lambda · Lambda Alias · Lambda Event · Lambda Info · Lambda Policy · Layman · Ldap Attr · Ldap Entry · Ldap Passwd · Librato Annotation · Lightsail · Lineinfile · Linode · Linode V4 · Listen Ports Facts · Lldp · Locale Gen · Logentries · Logentries Msg · Logicmonitor · Logicmonitor Facts · Logstash Plugin · Luks Device · Lvg · Lvol · Lxc Container · Lxca Cmms · Lxca Nodes · Lxd Container · Lxd Profile · Macports · Mail · Make · Manageiq Alert Profiles · Manageiq Alerts · Manageiq Group · Manageiq Policies · Manageiq Provider · Manageiq Tags · Manageiq Tenant · Manageiq User · Matrix · Mattermost · Maven Artifact · Memset Dns Reload · Memset Memstore Info · Memset Server Info · Memset Zone · Memset Zone Domain · Memset Zone Record · Meraki Admin · Meraki Config Template · Meraki Content Filtering · Meraki Device · Meraki Firewalled Services · Meraki Malware · Meraki Mr L3 Firewall · Meraki Mx L3 Firewall · Meraki Mx L7 Firewall · Meraki Nat · Meraki Network · Meraki Organization · Meraki Snmp · Meraki Ssid · Meraki Static Route · Meraki Switchport · Meraki Syslog · Meraki Vlan · Meraki Webhook · Meta · Mksysb · Modprobe · Mongodb Parameter · Mongodb Replicaset · Mongodb Shard · Mongodb User · Monit · Mount · Mqtt · Mso Label · Mso Role · Mso Schema · Mso Schema Site · Mso Schema Site Anp · Mso Schema Site Anp Epg · Mso Schema Site Anp Epg Domain · Mso Schema Site Anp Epg Staticleaf · Mso Schema Site Anp Epg Staticport · Mso Schema Site Anp Epg Subnet · Mso Schema Site Bd · Mso Schema Site Bd L3out · Mso Schema Site Bd Subnet · Mso Schema Site Vrf · Mso Schema Site Vrf Region · Mso Schema Site Vrf Region Cidr · Mso Schema Site Vrf Region Cidr Subnet · Mso Schema Template · Mso Schema Template Anp · Mso Schema Template Anp Epg · Mso Schema Template Anp Epg Contract · Mso Schema Template Anp Epg Subnet · Mso Schema Template Bd · Mso Schema Template Bd Subnet · Mso Schema Template Contract Filter · Mso Schema Template Deploy · Mso Schema Template Externalepg · Mso Schema Template Filter Entry · Mso Schema Template L3out · Mso Schema Template Vrf · Mso Site · Mso Tenant · Mso User · Mssql Db · Mysql Db · Mysql Info · Mysql Replication · Mysql User · Mysql Variables · Na Elementsw Access Group · Na Elementsw Account · Na Elementsw Admin Users · Na Elementsw Backup · Na Elementsw Check Connections · Na Elementsw Cluster · Na Elementsw Cluster Config · Na Elementsw Cluster Pair · Na Elementsw Cluster Snmp · Na Elementsw Drive · Na Elementsw Initiators · Na Elementsw Ldap · Na Elementsw Network Interfaces · Na Elementsw Node · Na Elementsw Snapshot · Na Elementsw Snapshot Restore · Na Elementsw Snapshot Schedule · Na Elementsw Vlan · Na Elementsw Volume · Na Elementsw Volume Clone · Na Elementsw Volume Pair · Na Ontap Aggregate · Na Ontap Autosupport · Na Ontap Broadcast Domain · Na Ontap Broadcast Domain Ports · Na Ontap Cg Snapshot · Na Ontap Cifs · Na Ontap Cifs Acl · Na Ontap Cifs Server · Na Ontap Cluster · Na Ontap Cluster Ha · Na Ontap Cluster Peer · Na Ontap Command · Na Ontap Disks · Na Ontap Dns · Na Ontap Export Policy · Na Ontap Export Policy Rule · Na Ontap Fcp · Na Ontap Firewall Policy · Na Ontap Firmware Upgrade · Na Ontap Flexcache · Na Ontap Igroup · Na Ontap Igroup Initiator · Na Ontap Info · Na Ontap Interface · Na Ontap Ipspace · Na Ontap Iscsi · Na Ontap Job Schedule · Na Ontap Kerberos Realm · Na Ontap Ldap · Na Ontap Ldap Client · Na Ontap License · Na Ontap Lun · Na Ontap Lun Copy · Na Ontap Lun Map · Na Ontap Motd · Na Ontap Ndmp · Na Ontap Net Ifgrp · Na Ontap Net Port · Na Ontap Net Routes · Na Ontap Net Subnet · Na Ontap Net Vlan · Na Ontap Nfs · Na Ontap Node · Na Ontap Ntp · Na Ontap Nvme · Na Ontap Nvme Namespace · Na Ontap Nvme Subsystem · Na Ontap Object Store · Na Ontap Ports · Na Ontap Portset · Na Ontap Qos Adaptive Policy Group · Na Ontap Qos Policy Group · Na Ontap Qtree · Na Ontap Quotas · Na Ontap Security Key Manager · Na Ontap Service Processor Network · Na Ontap Snapmirror · Na Ontap Snapshot · Na Ontap Snapshot Policy · Na Ontap Snmp · Na Ontap Software Update · Na Ontap Svm · Na Ontap Svm Options · Na Ontap Ucadapter · Na Ontap Unix Group · Na Ontap Unix User · Na Ontap User · Na Ontap User Role · Na Ontap Volume · Na Ontap Volume Autosize · Na Ontap Volume Clone · Na Ontap Vscan · Na Ontap Vscan On Access Policy · Na Ontap Vscan On Demand Task · Na Ontap Vscan Scanner Pool · Na Ontap Vserver Cifs Security · Na Ontap Vserver Peer · Nagios · Nclu · Net Get · Net Ping · Net Put · Netact Cm Command · Netapp E Alerts · Netapp E Amg · Netapp E Amg Role · Netapp E Amg Sync · Netapp E Asup · Netapp E Auditlog · Netapp E Auth · Netapp E Drive Firmware · Netapp E Facts · Netapp E Firmware · Netapp E Flashcache · Netapp E Global · Netapp E Host · Netapp E Hostgroup · Netapp E Iscsi Interface · Netapp E Iscsi Target · Netapp E Ldap · Netapp E Lun Mapping · Netapp E Mgmt Interface · Netapp E Snapshot Group · Netapp E Snapshot Images · Netapp E Snapshot Volume · Netapp E Storage System · Netapp E Storagepool · Netapp E Syslog · Netapp E Volume · Netapp E Volume Copy · Netbox Device · Netbox Interface · Netbox Ip Address · Netbox Prefix · Netbox Site · Netconf Config · Netconf Get · Netconf Rpc · Netcup Dns · Netscaler Cs Action · Netscaler Cs Policy · Netscaler Cs Vserver · Netscaler Gslb Service · Netscaler Gslb Site · Netscaler Gslb Vserver · Netscaler Lb Monitor · Netscaler Lb Vserver · Netscaler Nitro Request · Netscaler Save Config · Netscaler Server · Netscaler Service · Netscaler Servicegroup · Netscaler Ssl Certkey · Newrelic Deployment · Nexmo · Nginx Status Info · Nictagadm · Nios A Record · Nios Aaaa Record · Nios Cname Record · Nios Dns View · Nios Fixed Address · Nios Host Record · Nios Member · Nios Mx Record · Nios Naptr Record · Nios Network · Nios Network View · Nios Nsgroup · Nios Ptr Record · Nios Srv Record · Nios Txt Record · Nios Zone · Nitz · Nitz 2 · Nmcli · Nos Command · Nos Config · Nos Facts · Nosh · Npm · Nso Action · Nso Config · Nso Query · Nso Show · Nso Verify · Nsupdate · Nuage Vspk · Nxos Aaa Server · Nxos Aaa Server Host · Nxos Acl · Nxos Acl Interface · Nxos Banner · Nxos Bfd Global · Nxos Bfd Interfaces · Nxos Bgp · Nxos Bgp Af · Nxos Bgp Neighbor · Nxos Bgp Neighbor Af · Nxos Command · Nxos Config · Nxos Evpn Global · Nxos Evpn Vni · Nxos Facts · Nxos Feature · Nxos File Copy · Nxos Gir · Nxos Gir Profile Management · Nxos Hsrp · Nxos Igmp · Nxos Igmp Interface · Nxos Igmp Snooping · Nxos Install Os · Nxos Interface Ospf · Nxos Interfaces · Nxos L2 Interfaces · Nxos L3 Interfaces · Nxos Lacp · Nxos Lacp Interfaces · Nxos Lag Interfaces · Nxos Lldp · Nxos Lldp Global · Nxos Logging · Nxos Ntp · Nxos Ntp Auth · Nxos Ntp Options · Nxos Nxapi · Nxos Ospf · Nxos Ospf Vrf · Nxos Overlay Global · Nxos Pim · Nxos Pim Interface · Nxos Pim Rp Address · Nxos Ping · Nxos Reboot · Nxos Rollback · Nxos Rpm · Nxos Smu · Nxos Snapshot · Nxos Snmp Community · Nxos Snmp Contact · Nxos Snmp Host · Nxos Snmp Location · Nxos Snmp Traps · Nxos Snmp User · Nxos Static Route · Nxos System · Nxos Telemetry · Nxos Udld · Nxos Udld Interface · Nxos User · Nxos Vlans · Nxos Vpc · Nxos Vpc Interface · Nxos Vrf · Nxos Vrf Af · Nxos Vrf Interface · Nxos Vrrp · Nxos Vtp Domain · Nxos Vtp Password · Nxos Vtp Version · Nxos Vxlan Vtep · Nxos Vxlan Vtep Vni · Oci Vcn · Office 365 Connector Card · Ohai · Omapi Host · Ome Device Info · One Host · One Image · One Image Info · One Service · One Vm · Oneandone Firewall Policy · Oneandone Load Balancer · Oneandone Monitoring Policy · Oneandone Private Network · Oneandone Public Ip · Oneandone Server · Onepassword Info · Oneview Datacenter Info · Oneview Enclosure Info · Oneview Ethernet Network · Oneview Ethernet Network Info · Oneview Fc Network · Oneview Fc Network Info · Oneview Fcoe Network · Oneview Fcoe Network Info · Oneview Logical Interconnect Group · Oneview Logical Interconnect Group Info · Oneview Network Set · Oneview Network Set Info · Oneview San Manager · Oneview San Manager Info · Online Server Info · Online User Info · Onyx Bgp · Onyx Buffer Pool · Onyx Command · Onyx Config · Onyx Facts · Onyx Igmp · Onyx Igmp Interface · Onyx Igmp Vlan · Onyx Interface · Onyx L2 Interface · Onyx L3 Interface · Onyx Linkagg · Onyx Lldp · Onyx Lldp Interface · Onyx Magp · Onyx Mlag Ipl · Onyx Mlag Vip · Onyx Ospf · Onyx Pfc Interface · Onyx Protocol · Onyx Ptp Global · Onyx Ptp Interface · Onyx Qos · Onyx Traffic Class · Onyx Vlan · Onyx Vxlan · Onyx Wjh · Open Iscsi · Openbsd Pkg · Opendj Backendprop · Openssh Cert · Openssh Keypair · Openssl Certificate · Openssl Certificate Info · Openssl Csr · Openssl Csr Info · Openssl Dhparam · Openssl Pkcs12 · Openssl Privatekey · Openssl Privatekey Info · Openssl Publickey · Openvswitch Bridge · Openvswitch Db · Openvswitch Port · Openwrt Init · Opkg · Opx Cps · Ordnance Config · Ordnance Facts · Os Auth · Os Client Config · Os Coe Cluster · Os Coe Cluster Template · Os Flavor Info · Os Floating Ip · Os Group · Os Group Info · Os Image · Os Image Info · Os Ironic · Os Ironic Inspect · Os Ironic Node · Os Keypair · Os Keystone Domain · Os Keystone Domain Info · Os Keystone Endpoint · Os Keystone Role · Os Keystone Service · Os Listener · Os Loadbalancer · Os Member · Os Network · Os Networks Info · Os Nova Flavor · Os Nova Host Aggregate · Os Object · Os Pool · Os Port · Os Port Info · Os Project · Os Project Access · Os Project Info · Os Quota · Os Recordset · Os Router · Os Security Group · Os Security Group Rule · Os Server · Os Server Action · Os Server Group · Os Server Info · Os Server Metadata · Os Server Volume · Os Stack · Os Subnet · Os Subnets Info · Os User · Os User Group · Os User Info · Os User Role · Os Volume · Os Volume Snapshot · Os Zone · Osx Defaults · Ovh Ip Failover · Ovh Ip Loadbalancing Backend · Ovirt · Ovirt Affinity Group · Ovirt Affinity Label · Ovirt Affinity Label Info · Ovirt Api Info · Ovirt Auth · Ovirt Cluster · Ovirt Cluster Info · Ovirt Datacenter · Ovirt Datacenter Info · Ovirt Disk · Ovirt Disk Info · Ovirt Event · Ovirt Event Info · Ovirt External Provider · Ovirt External Provider Info · Ovirt Group · Ovirt Group Info · Ovirt Host · Ovirt Host Info · Ovirt Host Network · Ovirt Host Pm · Ovirt Host Storage Info · Ovirt Instance Type · Ovirt Job · Ovirt Mac Pool · Ovirt Network · Ovirt Network Info · Ovirt Nic · Ovirt Nic Info · Ovirt Permission · Ovirt Permission Info · Ovirt Quota · Ovirt Quota Info · Ovirt Role · Ovirt Scheduling Policy Info · Ovirt Snapshot · Ovirt Snapshot Info · Ovirt Storage Connection · Ovirt Storage Domain · Ovirt Storage Domain Info · Ovirt Storage Template Info · Ovirt Storage Vm Info · Ovirt Tag · Ovirt Tag Info · Ovirt Template · Ovirt Template Info · Ovirt User · Ovirt User Info · Ovirt Vm · Ovirt Vm Info · Ovirt Vmpool · Ovirt Vmpool Info · Ovirt Vnic Profile · Pacemaker Cluster · Package · Package Facts · Packet Device · Packet Sshkey · Pacman · Pagerduty · Pagerduty Alert · Pam Limits · Pamd · Parted · Patch · Pause · Pear · Picker · Pids · Ping · Pingdom · Pip · Pip Package Info · Pkg 5 · Pkg5 Publisher · Pkgin · Pkgng · Pkgutil · Pn Access List · Pn Access List Ip · Pn Admin Service · Pn Admin Session Timeout · Pn Admin Syslog · Pn Connection Stats Settings · Pn Cpu Class · Pn Cpu Mgmt Class · Pn Dhcp Filter · Pn Dscp Map · Pn Dscp Map Pri Map · Pn Fabric Local · Pn Igmp Snooping · Pn Ipv6security Raguard · Pn Ipv6security Raguard Port · Pn Ipv6security Raguard Vlan · Pn Log Audit Exception · Pn Port Config · Pn Port Cos Bw · Pn Port Cos Rate Setting · Pn Prefix List · Pn Prefix List Network · Pn Role · Pn Snmp Community · Pn Snmp Trap Sink · Pn Snmp Vacm · Pn Stp · Pn Stp Port · Pn Switch Setup · Pn User · Pn Vflow Table Profile · Pn Vrouter Bgp · Pn Vrouter Bgp Network · Pn Vrouter Interface Ip · Pn Vrouter Loopback Interface · Pn Vrouter Ospf · Pn Vrouter Ospf6 · Pn Vrouter Packet Relay · Pn Vrouter Pim Config · Pn Vtep · Podman Image · Podman Image Info · Portage · Portinstall · Postgresql Copy · Postgresql Db · Postgresql Ext · Postgresql Idx · Postgresql Info · Postgresql Lang · Postgresql Membership · Postgresql Owner · Postgresql Pg Hba · Postgresql Ping · Postgresql Privs · Postgresql Publication · Postgresql Query · Postgresql Schema · Postgresql Sequence · Postgresql Set · Postgresql Slot · Postgresql Table · Postgresql Tablespace · Postgresql User · Profitbricks · Profitbricks Datacenter · Profitbricks Nic · Profitbricks Volume · Profitbricks Volume Attachments · Proxmox · Proxmox Kvm · Proxmox Template · Proxysql Backend Servers · Proxysql Global Variables · Proxysql Manage Config · Proxysql Mysql Users · Proxysql Query Rules · Proxysql Replication Hostgroups · Proxysql Scheduler · Psexec · Pubnub Blocks · Pulp Repo · Puppet · Purefa Alert · Purefa Arrayname · Purefa Banner · Purefa Connect · Purefa Dns · Purefa Ds · Purefa Dsrole · Purefa Hg · Purefa Host · Purefa Info · Purefa Ntp · Purefa Offload · Purefa Pg · Purefa Pgsnap · Purefa Phonehome · Purefa Ra · Purefa Smtp · Purefa Snap · Purefa Snmp · Purefa Syslog · Purefa User · Purefa Vg · Purefa Volume · Purefb Bucket · Purefb Ds · Purefb Dsrole · Purefb Fs · Purefb Info · Purefb Network · Purefb Ra · Purefb S3acc · Purefb S3user · Purefb Smtp · Purefb Snap · Purefb Subnet · Pushbullet · Pushover · Python Requirements Info · Rabbitmq Binding · Rabbitmq Exchange · Rabbitmq Global Parameter · Rabbitmq Parameter · Rabbitmq Plugin · Rabbitmq Policy · Rabbitmq Publish · Rabbitmq Queue · Rabbitmq User · Rabbitmq Vhost · Rabbitmq Vhost Limits · Raw · Rax · Rax Cbs · Rax Cbs Attachments · Rax Cdb · Rax Cdb Database · Rax Cdb User · Rax Clb · Rax Clb Nodes · Rax Clb Ssl · Rax Dns · Rax Dns Record · Rax Facts · Rax Files · Rax Files Objects · Rax Identity · Rax Keypair · Rax Meta · Rax Mon Alarm · Rax Mon Check · Rax Mon Entity · Rax Mon Notification · Rax Mon Notification Plan · Rax Network · Rax Queue · Rax Scaling Group · Rax Scaling Policy · Rds · Rds Instance · Rds Instance Info · Rds Param Group · Rds Snapshot · Rds Snapshot Info · Rds Subnet Group · Read Csv · Reboot · Redfish Command · Redfish Config · Redfish Info · Redhat Subscription · Redis · Redshift · Redshift Cross Region Snapshots · Redshift Info · Redshift Subnet Group · Replace · Restconf Config · Restconf Get · Rhevm · Rhn Channel · Rhn Register · Rhsm Release · Rhsm Repository · Riak · Rocketchat · Rollbar Deployment · Route 53 · Route53 Health Check · Route53 Info · Route53 Zone · Routeros Command · Routeros Facts · Rpm Key · Rundeck Acl Policy · Rundeck Project · Runit · S3 Bucket · S3 Bucket Notification · S3 Lifecycle · S3 Logging · S3 Sync · S3 Website · Say · Scaleway Compute · Scaleway Image Info · Scaleway Ip · Scaleway Ip Info · Scaleway Lb · Scaleway Organization Info · Scaleway Security Group · Scaleway Security Group Info · Scaleway Security Group Rule · Scaleway Server Info · Scaleway Snapshot Info · Scaleway Sshkey · Scaleway User Data · Scaleway Volume · Scaleway Volume Info · Script · Seboolean · Sefcontext · Selinux · Selinux Permissive · Selogin · Sendgrid · Sensu Check · Sensu Client · Sensu Handler · Sensu Silence · Sensu Subscription · Seport · Serverless · Service · Service Facts · Set Fact · Set Internals · Set Stats · Setup · Shell · Skydive Capture · Skydive Edge · Skydive Node · Sl Vm · Slack · Slackpkg · Slurp · Slxos Command · Slxos Config · Slxos Facts · Slxos Interface · Slxos L2 Interface · Slxos L3 Interface · Slxos Linkagg · Slxos Lldp · Slxos Vlan · Smartos Image Info · Snap · Snmp Facts · Snow Record · Snow Record Find · Sns · Sns Topic · Solaris Zone · Sorcery · Spectrum Device · Spotinst Aws Elastigroup · Sqs Queue · Sros Command · Sros Config · Sros Rollback · Ss 3par Cpg · Stackdriver · Stacki Host · Stat · Statusio Maintenance · Sts Assume Role · Sts Session Token · Subversion · Supervisorctl · Svc · Svr 4 Pkg · Swdepot · Swupd · Synchronize · Sysctl · Syslogger · Syspatch · Systemd · Sysvinit · Taiga Issue · Telegram · Telnet · Tempfile · Template · Terraform · Timezone · Tower Credential · Tower Credential Type · Tower Group · Tower Host · Tower Inventory · Tower Inventory Source · Tower Job Cancel · Tower Job Launch · Tower Job List · Tower Job Template · Tower Job Wait · Tower Label · Tower Notification · Tower Organization · Tower Project · Tower Receive · Tower Role · Tower Send · Tower Settings · Tower Team · Tower User · Tower Workflow Launch · Tower Workflow Template · Twilio · Typetalk · Ucs Disk Group Policy · Ucs Dns Server · Ucs Ip Pool · Ucs Lan Connectivity · Ucs Mac Pool · Ucs Managed Objects · Ucs Ntp Server · Ucs Org · Ucs San Connectivity · Ucs Service Profile Template · Ucs Storage Profile · Ucs Timezone · Ucs Uuid Pool · Ucs Vhba Template · Ucs Vlan Find · Ucs Vlans · Ucs Vnic Template · Ucs Vsans · Ucs Wwn Pool · Udm Dns Record · Udm Dns Zone · Udm Group · Udm Share · Udm User · Ufw · Unarchive · Uptimerobot · Uri · Urpmi · User · Utm Aaa Group · Utm Aaa Group Info · Utm Ca Host Key Cert · Utm Ca Host Key Cert Info · Utm Dns Host · Utm Network Interface Address · Utm Network Interface Address Info · Utm Proxy Auth Profile · Utm Proxy Exception · Utm Proxy Frontend · Utm Proxy Frontend Info · Utm Proxy Location · Utm Proxy Location Info · Vca Fw · Vca Nat · Vca Vapp · Vcenter Extension · Vcenter Extension Info · Vcenter Folder · Vcenter License · Vdirect Commit · Vdirect File · Vdirect Runnable · Vdo · Vertica Configuration · Vertica Info · Vertica Role · Vertica Schema · Vertica User · Vexata Eg · Vexata Volume · Virt · Virt Net · Virt Pool · Vmadm · Vmware About Info · Vmware Category · Vmware Category Info · Vmware Cfg Backup · Vmware Cluster · Vmware Cluster Drs · Vmware Cluster Ha · Vmware Cluster Info · Vmware Cluster Vsan · Vmware Content Deploy Template · Vmware Content Library Info · Vmware Content Library Manager · Vmware Datacenter · Vmware Datastore Cluster · Vmware Datastore Info · Vmware Datastore Maintenancemode · Vmware Deploy Ovf · Vmware Dns Config · Vmware Drs Group · Vmware Drs Group Info · Vmware Drs Rule Info · Vmware Dvs Host · Vmware Dvs Portgroup · Vmware Dvs Portgroup Find · Vmware Dvs Portgroup Info · Vmware Dvswitch · Vmware Dvswitch Lacp · Vmware Dvswitch Nioc · Vmware Dvswitch Pvlans · Vmware Dvswitch Uplink Pg · Vmware Evc Mode · Vmware Export Ovf · Vmware Folder Info · Vmware Guest · Vmware Guest Boot Info · Vmware Guest Boot Manager · Vmware Guest Custom Attribute Defs · Vmware Guest Custom Attributes · Vmware Guest Customization Info · Vmware Guest Disk · Vmware Guest Disk Info · Vmware Guest File Operation · Vmware Guest Find · Vmware Guest Info · Vmware Guest Move · Vmware Guest Network · Vmware Guest Powerstate · Vmware Guest Screenshot · Vmware Guest Sendkey · Vmware Guest Snapshot · Vmware Guest Snapshot Info · Vmware Guest Tools Upgrade · Vmware Guest Tools Wait · Vmware Guest Video · Vmware Guest Vnc · Vmware Host · Vmware Host Acceptance · Vmware Host Active Directory · Vmware Host Capability Info · Vmware Host Config Info · Vmware Host Config Manager · Vmware Host Datastore · Vmware Host Dns Info · Vmware Host Facts · Vmware Host Feature Info · Vmware Host Firewall Info · Vmware Host Firewall Manager · Vmware Host Hyperthreading · Vmware Host Ipv6 · Vmware Host Kernel Manager · Vmware Host Lockdown · Vmware Host Ntp · Vmware Host Ntp Info · Vmware Host Package Info · Vmware Host Powermgmt Policy · Vmware Host Powerstate · Vmware Host Scanhba · Vmware Host Service Info · Vmware Host Service Manager · Vmware Host Snmp · Vmware Host Ssl Info · Vmware Host Vmhba Info · Vmware Host Vmnic Info · Vmware Local Role Info · Vmware Local Role Manager · Vmware Local User Info · Vmware Local User Manager · Vmware Maintenancemode · Vmware Migrate Vmk · Vmware Object Role Permission · Vmware Portgroup · Vmware Portgroup Info · Vmware Resource Pool · Vmware Resource Pool Info · Vmware Tag · Vmware Tag Info · Vmware Tag Manager · Vmware Target Canonical Info · Vmware Vcenter Settings · Vmware Vcenter Statistics · Vmware Vm Host Drs Rule · Vmware Vm Info · Vmware Vm Shell · Vmware Vm Storage Policy Info · Vmware Vm Vm Drs Rule · Vmware Vm Vss Dvs Migrate · Vmware Vmkernel · Vmware Vmkernel Info · Vmware Vmkernel Ip Config · Vmware Vmotion · Vmware Vsan Cluster · Vmware Vspan Session · Vmware Vswitch · Vmware Vswitch Info · Voss Command · Voss Config · Voss Facts · Vsphere Copy · Vsphere File · Vultr Account Info · Vultr Block Storage · Vultr Block Storage Info · Vultr Dns Domain · Vultr Dns Domain Info · Vultr Dns Record · Vultr Firewall Group · Vultr Firewall Group Info · Vultr Firewall Rule · Vultr Network · Vultr Network Info · Vultr Os Info · Vultr Plan Info · Vultr Region Info · Vultr Server · Vultr Server Info · Vultr Ssh Key · Vultr Ssh Key Info · Vultr Startup Script · Vultr Startup Script Info · Vultr User · Vultr User Info · Vyos Banner · Vyos Command · Vyos Config · Vyos Facts · Vyos Interfaces · Vyos L3 Interfaces · Vyos Lag Interfaces · Vyos Lldp Global · Vyos Lldp Interfaces · Vyos Logging · Vyos Ping · Vyos Static Route · Vyos System · Vyos User · Vyos Vlan · Wait For · Wait For Connection · Wakeonlan · Webfaction App · Webfaction Db · Webfaction Domain · Webfaction Mailbox · Webfaction Site · Win Acl · Win Acl Inheritance · Win Audit Policy System · Win Audit Rule · Win Certificate Store · Win Chocolatey · Win Chocolatey Config · Win Chocolatey Facts · Win Chocolatey Feature · Win Chocolatey Source · Win Command · Win Copy · Win Credential · Win Defrag · Win Disk Facts · Win Disk Image · Win Dns Client · Win Dns Record · Win Domain · Win Domain Computer · Win Domain Controller · Win Domain Group · Win Domain Group Membership · Win Domain Membership · Win Domain User · Win Dotnet Ngen · Win Dsc · Win Environment · Win Eventlog · Win Eventlog Entry · Win Feature · Win File · Win File Version · Win Find · Win Firewall · Win Firewall Rule · Win Format · Win Get Url · Win Group · Win Group Membership · Win Hostname · Win Hosts · Win Hotfix · Win Http Proxy · Win Iis Virtualdirectory · Win Iis Webapplication · Win Iis Webapppool · Win Iis Webbinding · Win Iis Website · Win Inet Proxy · Win Lineinfile · Win Mapped Drive · Win Msg · Win Netbios · Win Nssm · Win Optional Feature · Win Owner · Win Package · Win Pagefile · Win Partition · Win Path · Win Pester · Win Ping · Win Power Plan · Win Product Facts · Win Psexec · Win Psmodule · Win Psrepository · Win Rabbitmq Plugin · Win Rds Cap · Win Rds Rap · Win Rds Settings · Win Reboot · Win Reg Stat · Win Regedit · Win Region · Win Regmerge · Win Robocopy · Win Route · Win Say · Win Scheduled Task · Win Scheduled Task Stat · Win Security Policy · Win Service · Win Share · Win Shell · Win Shortcut · Win Snmp · Win Stat · Win Tempfile · Win Template · Win Timezone · Win Toast · Win Unzip · Win Updates · Win Uri · Win User · Win User Profile · Win User Right · Win Wait For · Win Wait For Process · Win Wakeonlan · Win Webpicmd · Win Whoami · Win Xml · Xattr · Xbps · Xenserver Facts · Xenserver Guest · Xenserver Guest Info · Xenserver Guest Powerstate · Xfconf · Xfs Quota · Xml · Yarn · Yum · Yum Repository · Zabbix Action · Zabbix Group · Zabbix Group Info · Zabbix Host · Zabbix Host Info · Zabbix Hostmacro · Zabbix Maintenance · Zabbix Map · Zabbix Mediatype · Zabbix Proxy · Zabbix Screen · Zabbix Template · Zfs · Zfs Delegate Admin · Zfs Facts · Znode · Zpool Facts · Zypper · Zypper Repository

Keywords

Keyword Arguments Documentation
A10 Server *arguments

Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' server object.

Arguments: state, server_ip, server_name, server_ports, partition, validate_certs, server_status

Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv2.

A10 Server Axapi3 *arguments

Manage A10 Networks AX/SoftAX/Thunder/vThunder devices

Arguments: server_ip, server_name, server_ports, operation, validate_certs, server_status

Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv3.

A10 Service Group *arguments

Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' service groups.

Arguments: service_group, service_group_protocol, service_group_method, partition, validate_certs, state, servers

Manage SLB (Server Load Balancing) service-group objects on A10 Networks devices via aXAPIv2.

A10 Virtual Server *arguments

Manage A10 Networks AX/SoftAX/Thunder/vThunder devices' virtual servers.

Arguments: state, virtual_server_status, virtual_server, validate_certs, virtual_server_ip, partition, virtual_server_ports

Manage SLB (Server Load Balancing) virtual server objects on A10 Networks devices via aXAPIv2.

Aci Aaa User *arguments

Manage AAA users (aaa:User)

Arguments: first_name, aaa_user, description, aaa_password_update_required, expires, enabled, clear_password_history, aaa_password, phone, state, last_name, expiration, aaa_password_lifetime, email

Manage AAA users on Cisco ACI fabrics.

Aci Aaa User Certificate *arguments

Manage AAA user certificates (aaa:UserCert)

Arguments: certificate_name, state, aaa_user, certificate, aaa_user_type

Manage AAA user certificates on Cisco ACI fabrics.

Aci Access Port Block To Access Port *arguments

Manage port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:PortBlk)

Arguments: from_port, from_card, access_port_selector, leaf_port_blk, to_card, leaf_port_blk_description, to_port, state, leaf_interface_profile

Manage port blocks of Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.

Aci Access Port To Interface Policy Leaf Profile *arguments

Manage Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:RsAccBaseGrp, infra:PortBlk)

Arguments: from_port, from_card, description, access_port_selector, interface_type, leaf_port_blk, policy_group, to_card, leaf_port_blk_description, to_port, state, leaf_interface_profile

Manage Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.

Aci Access Sub Port Block To Access Port *arguments

Manage sub port blocks of Fabric interface policy leaf profile interface selectors (infra:HPortS, infra:SubPortBlk)

Arguments: to_sub_port, from_port, from_card, from_sub_port, access_port_selector, leaf_port_blk, to_card, leaf_port_blk_description, to_port, state, leaf_interface_profile

Manage sub port blocks of Fabric interface policy leaf profile interface selectors on Cisco ACI fabrics.

Aci Aep *arguments

Manage attachable Access Entity Profile (AEP) objects (infra:AttEntityP, infra:ProvAcc)

Arguments: aep, state, infra_vlan, description

Connect to external virtual and physical domains by using attachable Access Entity Profiles (AEP) on Cisco ACI fabrics.

Aci Aep To Domain *arguments

Bind AEPs to Physical or Virtual Domains (infra:RsDomP)

Arguments: domain_type, aep, domain, state, vm_provider

Bind AEPs to Physical or Virtual Domains on Cisco ACI fabrics.

Aci Ap *arguments

Manage top level Application Profile (AP) objects (fv:Ap)

Arguments: ap, state, description, tenant

Manage top level Application Profile (AP) objects on Cisco ACI fabrics

Aci Bd *arguments

Manage Bridge Domains (BD) objects (fv:BD)

Arguments: bd, arp_flooding, igmp_snoop_policy, endpoint_retention_action, description, l3_unknown_multicast, enable_routing, vrf, bd_type, ip_learning, tenant, l2_unknown_unicast, endpoint_retention_policy, multi_dest, endpoint_clear, state, ipv6_nd_policy, mac_address, endpoint_move_detect, enable_multicast, limit_ip_learn

Manages Bridge Domains (BD) on Cisco ACI fabrics.

Aci Bd Subnet *arguments

Manage Subnets (fv:Subnet)

Arguments: bd, description, nd_prefix_policy, enable_vip, mask, preferred, subnet_control, state, route_profile, route_profile_l3_out, scope, gateway, tenant, subnet_name

Manage Subnets on Cisco ACI fabrics.

Aci Bd To L3out *arguments

Bind Bridge Domain to L3 Out (fv:RsBDToOut)

Arguments: bd, l3out, state, tenant

Bind Bridge Domain to L3 Out on Cisco ACI fabrics.

Aci Config Rollback *arguments

Provides rollback and rollback preview functionality (config:ImportP)

Arguments: export_policy, import_mode, description, fail_on_decrypt, compare_export_policy, state, snapshot, import_type, compare_snapshot, import_policy

Provides rollback and rollback preview functionality for Cisco ACI fabrics. Config Rollbacks are done using snapshots C(aci_snapshot) with the configImportP class.

Aci Config Snapshot *arguments

Manage Config Snapshots (config:Snapshot, config:ExportP)

Arguments: include_secure, state, snapshot, description, format, export_policy, max_count

Manage Config Snapshots on Cisco ACI fabrics. Creating new Snapshots is done using the configExportP class. Removing Snapshots is done using the configSnapshot class.

Aci Contract *arguments

Manage contract resources (vz:BrCP)

Arguments: priority, contract, state, description, scope, dscp, tenant

Manage Contract resources on Cisco ACI fabrics.

Aci Contract Subject *arguments

Manage initial Contract Subjects (vz:Subj)

Arguments: description, consumer_match, dscp, priority, state, contract, reverse_filter, provider_match, tenant, subject

Manage initial Contract Subjects on Cisco ACI fabrics.

Aci Contract Subject To Filter *arguments

Bind Contract Subjects to Filters (vz:RsSubjFiltAtt)

Arguments: filter, state, log, subject, contract, tenant

Bind Contract Subjects to Filters on Cisco ACI fabrics.

Aci Domain *arguments

Manage physical, virtual, bridged, routed or FC domain profiles (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)

Arguments: domain, dscp, domain_type, state, encap_mode, vswitch, multicast_address, vm_provider

Manage physical, virtual, bridged, routed or FC domain profiles on Cisco ACI fabrics.

Aci Domain To Encap Pool *arguments

Bind Domain to Encap Pools (infra:RsVlanNs)

Arguments: pool_type, domain_type, domain, pool_allocation_mode, vm_provider, state, pool

Bind Domain to Encap Pools on Cisco ACI fabrics.

Aci Domain To Vlan Pool *arguments

Bind Domain to VLAN Pools (infra:RsVlanNs)

Arguments: domain_type, domain, pool_allocation_mode, vm_provider, state, pool

Bind Domain to VLAN Pools on Cisco ACI fabrics.

Aci Encap Pool *arguments

Manage encap pools (fvns:VlanInstP, fvns:VxlanInstP, fvns:VsanInstP)

Arguments: pool_type, state, pool_allocation_mode, description, pool

Manage vlan, vxlan, and vsan pools on Cisco ACI fabrics.

Aci Encap Pool Range *arguments

Manage encap ranges assigned to pools (fvns:EncapBlk, fvns:VsanEncapBlk)

Arguments: range_end, range_start, pool_allocation_mode, description, pool_type, state, allocation_mode, pool, range_name

Manage vlan, vxlan, and vsan ranges that are assigned to pools on Cisco ACI fabrics.

Aci Epg *arguments

Manage End Point Groups (EPG) objects (fv:AEPg)

Arguments: bd, description, fwd_control, priority, ap, state, preferred_group, epg, intra_epg_isolation, tenant

Manage End Point Groups (EPG) on Cisco ACI fabrics.

Aci Epg Monitoring Policy *arguments

Manage monitoring policies (mon:EPGPol)

Arguments: monitoring_policy, description, tenant, state

Manage monitoring policies on Cisco ACI fabrics.

Aci Epg To Contract *arguments

Bind EPGs to Contracts (fv:RsCons, fv:RsProv)

Arguments: contract, priority, ap, state, contract_type, epg, provider_match, tenant

Bind EPGs to Contracts on Cisco ACI fabrics.

Aci Epg To Domain *arguments

Bind EPGs to Domains (fv:RsDomAtt)

Arguments: domain, ap, allow_useg, switching_mode, deploy_immediacy, resolution_immediacy, domain_type, primary_encap, state, encap, encap_mode, epg, vm_provider, netflow, tenant

Bind EPGs to Physical and Virtual Domains on Cisco ACI fabrics.

Aci Fabric Node *arguments

Manage Fabric Node Members (fabric:NodeIdentP)

Arguments: state, node_id, role, description, serial, switch, pod_id

Manage Fabric Node Members on Cisco ACI fabrics.

Aci Fabric Scheduler *arguments

This modules creates ACI schedulers.

Arguments: name, hour, state, concurCap, windowname, date, maxTime, recurring, day, minute, description

With the module you can create schedule policies that can be a shell, onetime execution or recurring

Aci Filter *arguments

Manages top level filter objects (vz:Filter)

Arguments: filter, state, description, tenant

Manages top level filter objects on Cisco ACI fabrics. This modules does not manage filter entries, see M(aci_filter_entry) for this functionality.

Aci Filter Entry *arguments

Manage filter entries (vz:Entry)

Arguments: filter, dst_port_start, dst_port_end, description, icmp6_msg_type, icmp_msg_type, arp_flag, stateful, state, ether_type, dst_port, entry, tenant, ip_protocol

Manage filter entries for a filter on Cisco ACI fabrics.

Aci Firmware Group *arguments

This module creates a firmware group

Arguments: state, firmwarepol, group

This module creates a firmware group, so that you can apply firmware policy to nodes.

Aci Firmware Group Node *arguments

This modules adds and remove nodes from the firmware group

Arguments: node, state, group

This module addes/deletes a node to the firmware group. This modules assigns 1 node at a time.

Aci Firmware Policy *arguments

This creates a firmware policy

Arguments: ignoreCompat, state, version, name

This module creates a firmware policy for firmware groups. The firmware policy is create first and then referenced by the firmware group. You will assign the firmware and specify if you want to ignore the compatibility check

Aci Firmware Source *arguments

Manage firmware image sources (firmware:OSource)

Arguments: url_password, url_protocol, url_username, source, url, polling_interval, state

Manage firmware image sources on Cisco ACI fabrics.

Aci Interface Policy Cdp *arguments

Manage CDP interface policies (cdp:IfPol)

Arguments: cdp_policy, admin_state, description, state

Manage CDP interface policies on Cisco ACI fabrics.

Aci Interface Policy Fc *arguments

Manage Fibre Channel interface policies (fc:IfPol)

Arguments: state, fc_policy, port_mode, description

Manage ACI Fiber Channel interface policies on Cisco ACI fabrics.

Aci Interface Policy L2 *arguments

Manage Layer 2 interface policies (l2:IfPol)

Arguments: state, description, vepa, vlan_scope, l2_policy, qinq

Manage Layer 2 interface policies on Cisco ACI fabrics.

Aci Interface Policy Leaf Policy Group *arguments

Manage fabric interface policy leaf policy groups (infra:AccBndlGrp, infra:AccPortGrp)

Arguments: stp_interface_policy, description, egress_data_plane_policing_policy, cdp_policy, storm_control_interface_policy, port_channel_policy, mcp_policy, lag_type, monitoring_policy, aep, priority_flow_control_policy, fibre_channel_interface_policy, l2_interface_policy, policy_group, port_security_policy, link_level_policy, state, ingress_data_plane_policing_policy, slow_drain_policy, lldp_policy

Manage fabric interface policy leaf policy groups on Cisco ACI fabrics.

Aci Interface Policy Leaf Profile *arguments

Manage fabric interface policy leaf profiles (infra:AccPortP)

Arguments: state, leaf_interface_profile, description

Manage fabric interface policy leaf profiles on Cisco ACI fabrics.

Aci Interface Policy Lldp *arguments

Manage LLDP interface policies (lldp:IfPol)

Arguments: receive_state, lldp_policy, transmit_state, description, state

Manage LLDP interface policies on Cisco ACI fabrics.

Aci Interface Policy Mcp *arguments

Manage MCP interface policies (mcp:IfPol)

Arguments: state, admin_state, description, mcp

Manage MCP interface policies on Cisco ACI fabrics.

Aci Interface Policy Ospf *arguments

Manage OSPF interface policies (ospf:IfPol)

Arguments: tenant, retransmit_interval, cost, description, controls, priority, state, dead_interval, prefix_suppression, hello_interval, ospf, network_type, transmit_delay

Manage OSPF interface policies on Cisco ACI fabrics.

Aci Interface Policy Port Channel *arguments

Manage port channel interface policies (lacp:LagPol)

Arguments: graceful_convergence, description, load_defer, symmetric_hash, suspend_individual, state, mode, min_links, port_channel, fast_select, max_links

Manage port channel interface policies on Cisco ACI fabrics.

Aci Interface Policy Port Security *arguments

Manage port security (l2:PortSecurityPol)

Arguments: port_security, port_security_timeout, max_end_points, description, state

Manage port security on Cisco ACI fabrics.

Aci Interface Selector To Switch Policy Leaf Profile *arguments

Bind interface selector profiles to switch policy leaf profiles (infra:RsAccPortP)

Arguments: interface_selector, state, leaf_profile

Bind interface selector profiles to switch policy leaf profiles on Cisco ACI fabrics.

Aci L3out *arguments

Manage Layer 3 Outside (L3Out) objects (l3ext:Out)

Arguments: domain, description, dscp, l3protocol, l3out, state, route_control, vrf, asn, tenant

Manage Layer 3 Outside (L3Out) on Cisco ACI fabrics.

Aci L3out Extepg *arguments

Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Arguments: l3out, state, preferred_group, description, extepg, dscp, tenant

Manage External Network Instance Profile (ExtEpg) objects (l3extInstP:instP)

Aci L3out Extsubnet *arguments

Manage External Subnet objects (l3extSubnet:extsubnet)

Arguments: description, l3out, state, subnet_name, extepg, scope, tenant, network

Manage External Subnet objects (l3extSubnet:extsubnet)

Aci L3out Route Tag Policy *arguments

Manage route tag policies (l3ext:RouteTagPol)

Arguments: state, tag, rtp, tenant, description

Manage route tag policies on Cisco ACI fabrics.

Aci Maintenance Group *arguments

This creates an ACI maintenance group

Arguments: policy, state, group

This modules creates an ACI maintenance group

Aci Maintenance Group Node *arguments

Manage maintenance group nodes

Arguments: node, state, group

Manage maintenance group nodes

Aci Maintenance Policy *arguments

Manage firmware maintenance policies

Arguments: runmode, state, name, scheduler, ignoreCompat, graceful, adminst

Manage maintenance policies that defines behavior during an ACI upgrade.

Aci Rest *arguments

Direct access to the Cisco APIC REST API

Arguments: content, path, method, src

Enables the management of the Cisco ACI fabric through direct access to the Cisco APIC REST API. Thanks to the idempotent nature of the APIC, this module is idempotent and reports changes.

Aci Static Binding To Epg *arguments

Bind static paths to EPGs (fv:RsPathAtt)

Arguments: interface_mode, description, interface_type, primary_encap_id, deploy_immediacy, encap_id, ap, state, leafs, interface, epg, pod_id, tenant, extpaths

Bind static paths to EPGs on Cisco ACI fabrics.

Aci Switch Leaf Selector *arguments

Bind leaf selectors to switch policy leaf profiles (infra:LeafS, infra:NodeBlk, infra:RsAccNodePGrep)

Arguments: from, description, leaf_profile, to, state, leaf_node_blk_description, leaf, leaf_node_blk, policy_group

Bind leaf selectors (with node block range and policy group) to switch policy leaf profiles on Cisco ACI fabrics.

Aci Switch Policy Leaf Profile *arguments

Manage switch policy leaf profiles (infra:NodeP)

Arguments: state, description, leaf_profile

Manage switch policy leaf profiles on Cisco ACI fabrics.

Aci Switch Policy Vpc Protection Group *arguments

Manage switch policy explicit vPC protection groups (fabric:ExplicitGEp, fabric:NodePEp).

Arguments: vpc_domain_policy, state, protection_group, switch_2_id, switch_1_id, protection_group_id

Manage switch policy explicit vPC protection groups on Cisco ACI fabrics.

Aci Taboo Contract *arguments

Manage taboo contracts (vz:BrCP)

Arguments: scope, taboo_contract, description, tenant, state

Manage taboo contracts on Cisco ACI fabrics.

Aci Tenant *arguments

Manage tenants (fv:Tenant)

Arguments: state, description, tenant

Manage tenants on Cisco ACI fabrics.

Aci Tenant Action Rule Profile *arguments

Manage action rule profiles (rtctrl:AttrP)

Arguments: action_rule, state, description, tenant

Manage action rule profiles on Cisco ACI fabrics.

Aci Tenant Ep Retention Policy *arguments

Manage End Point (EP) retention protocol policies (fv:EpRetPol)

Arguments: description, hold_interval, epr_policy, bounce_trigger, state, local_ep_interval, bounce_age, move_frequency, remote_ep_interval, tenant

Manage End Point (EP) retention protocol policies on Cisco ACI fabrics.

Aci Tenant Span Dst Group *arguments

Manage SPAN destination groups (span:DestGrp)

Arguments: state, dst_group, description, tenant

Manage SPAN destination groups on Cisco ACI fabrics.

Aci Tenant Span Src Group *arguments

Manage SPAN source groups (span:SrcGrp)

Arguments: state, admin_state, description, dst_group, tenant, src_group

Manage SPAN source groups on Cisco ACI fabrics.

Aci Tenant Span Src Group To Dst Group *arguments

Bind SPAN source groups to destination groups (span:SpanLbl)

Arguments: state, dst_group, description, tenant, src_group

Bind SPAN source groups to associated destination groups on Cisco ACI fabrics.

Aci Vlan Pool *arguments

Manage VLAN pools (fvns:VlanInstP)

Arguments: state, pool_allocation_mode, description, pool

Manage VLAN pools on Cisco ACI fabrics.

Aci Vlan Pool Encap Block *arguments

Manage encap blocks assigned to VLAN pools (fvns:EncapBlk)

Arguments: pool_allocation_mode, block_end, description, block_start, block_name, state, allocation_mode, pool

Manage VLAN encap blocks that are assigned to VLAN pools on Cisco ACI fabrics.

Aci Vmm Credential *arguments

Manage virtual domain credential profiles (vmm:UsrAccP)

Arguments: domain, name, credential_username, vm_provider, state, credential_password, description

Manage virtual domain credential profiles on Cisco ACI fabrics.

Aci Vrf *arguments

Manage contexts or VRFs (fv:Ctx)

Arguments: tenant, state, policy_control_preference, description, policy_control_direction, vrf

Manage contexts or VRFs on Cisco ACI fabrics. Each context is a private network associated to a tenant, i.e. VRF.

Acl *arguments

Set and retrieve file ACL information.

Arguments: recursive, default, recalculate_mask, entity, state, follow, etype, entry, path, permissions, use_nfsv4_acls

Set and retrieve file ACL information.

Acme Account *arguments

Create, modify or delete ACME accounts

Arguments: state, contact, terms_agreed, new_account_key_content, new_account_key_src, allow_creation

Allows to create, modify or delete accounts with a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/). This module only works with the ACME v2 protocol.

Acme Account Info *arguments

Retrieves information on ACME accounts

Arguments: retrieve_orders

Allows to retrieve information on accounts a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/). This module only works with the ACME v2 protocol.

Acme Certificate *arguments

Create SSL/TLS certificates with the ACME protocol

Arguments: force, account_email, dest, remaining_days, challenge, fullchain_dest, modify_account, agreement, data, retrieve_all_alternates, terms_agreed, csr, chain_dest, deactivate_authzs

Create and renew SSL/TLS certificates with a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/) or L(Buypass,https://www.buypass.com/). The current implementation supports the C(http-01), C(dns-01) and C(tls-alpn-01) challenges. To use this module, it has to be executed twice. Either as two different tasks in the same run or during two runs. Note that the output of the first run needs to be recorded and passed to the second run as the module argument C(data). Between these two tasks you have to fulfill the required steps for the chosen challenge by whatever means necessary. For C(http-01) that means creating the necessary challenge file on the destination webserver. For C(dns-01) the necessary dns record has to be created. For C(tls-alpn-01) the necessary certificate has to be created and served. It is I(not) the responsibility of this module to perform these steps. For details on how to fulfill these challenges, you might have to read through L(the main ACME specification,https://tools.ietf.org/html/rfc8555#section-8) and the L(TLS-ALPN-01 specification,https://www.rfc-editor.org/rfc/rfc8737.html#section-3). Also, consider the examples provided for this module. The module includes experimental support for IP identifiers according to the L(RFC 8738,https://www.rfc-editor.org/rfc/rfc8738.html).

Acme Certificate Revoke *arguments

Revoke certificates with the ACME protocol

Arguments: private_key_content, private_key_src, account_key_content, certificate, revoke_reason, account_key_src

Allows to revoke certificates issued by a CA supporting the L(ACME protocol,https://tools.ietf.org/html/rfc8555), such as L(Let's Encrypt,https://letsencrypt.org/).

Acme Challenge Cert Helper *arguments

Prepare certificates required for ACME challenges such as C(tls-alpn-01)

Arguments: challenge_data, private_key_src, challenge, private_key_content

Prepares certificates for ACME challenges such as C(tls-alpn-01). The raw data is provided by the M(acme_certificate) module, and needs to be converted to a certificate to be used for challenge validation. This module provides a simple way to generate the required certificates.

Acme Inspect *arguments

Send direct requests to an ACME server

Arguments: url, content, fail_on_acme_error, method

Allows to send direct requests to an ACME server with the L(ACME protocol,https://tools.ietf.org/html/rfc8555), which is supported by CAs such as L(Let's Encrypt,https://letsencrypt.org/). This module can be used to debug failed certificate request attempts, for example when M(acme_certificate) fails or encounters a problem which you wish to investigate. The module can also be used to directly access features of an ACME servers which are not yet supported by the Ansible ACME modules.

Add Host *arguments

Add a host (and alternatively a group) to the ansible-playbook in-memory inventory

Arguments: name, groups

Use variables to create new hosts and groups in inventory for use in later plays of the same playbook. Takes variables so you can define the new hosts more fully. This module is also supported for Windows targets.

Aerospike Migrations *arguments

Check or wait for migrations between nodes

Arguments: tries_limit, consecutive_good_checks, local_only, min_cluster_size, migrate_tx_key, port, host, target_cluster_size, fail_on_cluster_change, sleep_between_checks, connect_timeout, migrate_rx_key

This can be used to check for migrations in a cluster. This makes it easy to do a rolling upgrade/update on Aerospike nodes. If waiting for migrations is not desired, simply just poll until port 3000 if available or asinfo -v status returns ok

Airbrake Deployment *arguments

Notify airbrake about app deployments

Arguments: repo, environment, token, user, url, validate_certs, revision

Notify airbrake about app deployments (see http://help.airbrake.io/kb/api-2/deploy-tracking)

Aireos Command *arguments

Run commands on remote devices running Cisco WLC

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an aireos node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. Commands run in configuration mode with this module are not idempotent. Please use M(aireos_config) to configure WLC devices.

Aireos Config *arguments

Manage Cisco WLC configurations

Arguments: src, backup_options, after, lines, diff_against, intended_config, running_config, save, before, save_when, backup, match, diff_ignore_lines

AireOS does not use a block indent file syntax, so there are no sections or parents. This module provides an implementation for working with AireOS configurations in a deterministic way.

Aix Devices *arguments

Manages AIX devices

Arguments: device, attributes, state, force, recursive

This module discovers, defines, removes and modifies attributes of AIX devices.

Aix Filesystem *arguments

Configure LVM and NFS file systems for AIX

Arguments: vg, account_subsystem, auto_mount, mount_group, state, fs_type, rm_mount_point, filesystem, device, attributes, permissions, nfs_server, size

This module creates, removes, mount and unmount LVM and NFS file system for AIX using C(/etc/filesystems). For LVM file systems is possible to resize a file system.

Aix Inittab *arguments

Manages the inittab on AIX

Arguments: action, state, command, name, runlevel, insertafter

Manages the inittab on AIX.

Aix Lvg *arguments

Manage LVM volume groups on AIX

Arguments: pvs, force, vg, pp_size, state, vg_type

This module creates, removes or resize volume groups on AIX LVM.

Aix Lvol *arguments

Configure AIX LVM logical volumes

Arguments: pvs, lv_type, vg, copies, lv, state, policy, opts, size

This module creates, removes or resizes AIX logical volumes. Inspired by lvol module.

Ali Instance *arguments

Create, Start, Stop, Restart or Terminate an Instance in ECS. Add or Remove Instance to/from a Security Group.

Arguments: max_bandwidth_in, force, auto_renew, availability_zone, key_name, system_disk_size, period, instance_ids, user_data, image_id, auto_renew_period, system_disk_description, password, security_groups, internet_charge_type, count, allocate_public_ip, instance_type, vswitch_id, description, max_bandwidth_out, instance_name, system_disk_name, state, host_name, count_tag, instance_tags, instance_charge_type, system_disk_category

Create, start, stop, restart, modify or terminate ecs instances. Add or remove ecs instances to/from security group.

Ali Instance Info *arguments

Gather information on instances of Alibaba Cloud ECS.

Arguments: instance_names, instance_tags, instance_ids, availability_zone

This module fetches data from the Open API in Alicloud. The module must be called from within the ECS instance itself. This module was called C(ali_instance_facts) before Ansible 2.9. The usage did not change.

Alternatives *arguments

Manages alternative programs for common commands

Arguments: priority, path, link, name

Manages symbolic links using the 'update-alternatives' tool. Useful when multiple programs are installed but provide similar functionality (e.g. different editors).

Apache2 Mod Proxy *arguments

Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool

Arguments: tls, balancer_vhost, member_host, validate_certs, state, balancer_url_suffix

Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool, using HTTP POST and GET requests. The httpd mod_proxy balancer-member status page has to be enabled and accessible, as this module relies on parsing this page. This module supports ansible check_mode, and requires BeautifulSoup python module.

Apache2 Module *arguments

Enables/disables a module of the Apache2 webserver.

Arguments: state, identifier, force, name, ignore_configcheck

Enables or disables a specified module of the Apache2 webserver.

Apk *arguments

Manages apk packages

Arguments: available, state, upgrade, update_cache, name, repository

Manages I(apk) packages for Alpine Linux.

Apt *arguments

Manages apt-packages

Arguments: autoremove, force, force_apt_get, update_cache, only_upgrade, deb, cache_valid_time, dpkg_options, upgrade, name, policy_rc_d, autoclean, purge, allow_unauthenticated, state, default_release, install_recommends

Manages I(apt) packages (such as for Debian/Ubuntu).

Apt Key *arguments

Add or remove an apt key

Arguments: keyserver, url, data, keyring, state, file, validate_certs, id

Add or remove an I(apt) key, optionally downloading it.

Apt Repo *arguments

Manage APT repositories via apt-repo

Arguments: repo, state, remove_others, update

Manages APT repositories using apt-repo tool. See U(https://www.altlinux.org/Apt-repo) for details about apt-repo

Apt Repository *arguments

Add and remove APT repositories

Arguments: repo, state, update_cache, mode, codename, validate_certs, filename

Add or remove an APT repositories in Ubuntu and Debian.

Apt Rpm *arguments

apt_rpm package manager

Arguments: state, update_cache, pkg

Manages packages with I(apt-rpm). Both low-level (I(rpm)) and high-level (I(apt-get)) package manager binaries required.

Archive *arguments

Creates a compressed archive of one or more files or trees

Arguments: force_archive, exclude_path, format, dest, path, remove

Packs an archive. It is the opposite of M(unarchive). By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying I(remove=True).

Aruba Command *arguments

Run commands on remote devices running Aruba Mobility Controller

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an aruba node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(aruba_config) to configure Aruba devices.

Aruba Config *arguments

Manage Aruba configuration sections

Arguments: src, backup_options, encrypt, after, lines, intended_config, diff_against, parents, save_when, before, running_config, replace, backup, match, diff_ignore_lines

Aruba configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with Aruba configuration sections in a deterministic way.

Asa Acl *arguments

Manage access-lists on a Cisco ASA

Arguments: force, before, config, after, lines, match, replace

This module allows you to work with access-lists on a Cisco ASA device.

Asa Command *arguments

Run arbitrary commands on Cisco ASA devices

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an ASA node and returns the results read from the device. The C(asa_command) module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Asa Config *arguments

Manage configuration sections on Cisco ASA devices

Arguments: src, passwords, backup, after, lines, replace, backup_options, parents, defaults, save, config, match, before

Cisco ASA configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with ASA configuration sections in a deterministic way.

Asa Og *arguments

Manage object groups on a Cisco ASA

Arguments: protocol, description, name, ip_mask, host_ip, group_object, port_range, state, port_eq, group_type, service_cfg

This module allows you to create and update object-group network/service on Cisco ASA device.

Assemble *arguments

Assemble configuration files from fragments

Arguments: ignore_hidden, src, remote_src, dest, delimiter, regexp, validate, backup

Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a C(conf.d) style structure where it is easy to build up the configuration from multiple sources. C(assemble) will take a directory of files that can be local or have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea I(fragments).

Assert *arguments

Asserts given expressions are true

Arguments: fail_msg, success_msg, quiet, that

This module asserts that given expressions are true with an optional custom message. This module is also supported for Windows targets.

Async Status *arguments

Obtain status of asynchronous task

Arguments: jid, mode

This module gets the status of an asynchronous task. This module is also supported for Windows targets.

Async Wrapper *arguments

Manage Layer-3 interfaces on Lenovo CNOS network devices.

Arguments: state, name, ipv6, aggregate, provider, ipv4

Removed keyword

At *arguments

Schedule the execution of a command or script file via the at command

Arguments: count, state, command, units, unique, script_file

Use this module to schedule a command or script file to run once in the future. All jobs are executed in the 'a' queue.

Atomic Container *arguments

Manage the containers on the atomic host platform

Arguments: state, values, name, rootfs, image, backend, mode

Manage the containers on the atomic host platform Allows to manage the lifecycle of a container on the atomic host platform

Atomic Host *arguments

Manage the atomic host platform

Arguments: revision

Manage the atomic host platform. Rebooting of Atomic host platform should be done outside this module.

Atomic Image *arguments

Manage the container images on the atomic host platform

Arguments: started, state, name, backend

Manage the container images on the atomic host platform. Allows to execute the commands specified by the RUN label in the container image when present.

Authorized Key *arguments

Adds or removes an SSH authorized key

Arguments: comment, exclusive, key_options, state, user, key, path, follow, validate_certs, manage_dir

Adds or removes SSH authorized keys for particular user accounts.

Avi Actiongroupconfig *arguments

Module for setup of ActionGroupConfig Avi RESTful Object

Arguments: snmp_trap_profile_ref, uuid, name, level, url, syslog_config_ref, tenant_ref, state, action_script_config_ref, autoscale_trigger_notification, avi_api_patch_op, external_only, email_config_ref, avi_api_update_method, description

This module is used to configure ActionGroupConfig object more examples at U(https://github.com/avinetworks/devops)

Avi Alertconfig *arguments

Module for setup of AlertConfig Avi RESTful Object

Arguments: description, tenant_ref, object_type, autoscale_alert, obj_uuid, recommendation, threshold, throttle, avi_api_update_method, name, category, expiry_time, uuid, url, enabled, avi_api_patch_op, summary, rolling_window, source, state, alert_rule, action_group_ref

This module is used to configure AlertConfig object more examples at U(https://github.com/avinetworks/devops)

Avi Alertemailconfig *arguments

Module for setup of AlertEmailConfig Avi RESTful Object

Arguments: to_emails, uuid, url, description, cc_emails, tenant_ref, state, avi_api_patch_op, avi_api_update_method, name

This module is used to configure AlertEmailConfig object more examples at U(https://github.com/avinetworks/devops)

Avi Alertscriptconfig *arguments

Module for setup of AlertScriptConfig Avi RESTful Object

Arguments: action_script, uuid, url, tenant_ref, state, avi_api_patch_op, avi_api_update_method, name

This module is used to configure AlertScriptConfig object more examples at U(https://github.com/avinetworks/devops)

Avi Alertsyslogconfig *arguments

Module for setup of AlertSyslogConfig Avi RESTful Object

Arguments: syslog_servers, uuid, url, description, tenant_ref, state, avi_api_patch_op, avi_api_update_method, name

This module is used to configure AlertSyslogConfig object more examples at U(https://github.com/avinetworks/devops)

Avi Analyticsprofile *arguments

Module for setup of AnalyticsProfile Avi RESTful Object

Arguments: disable_se_analytics, apdex_server_rtt_tolerated_factor, hs_security_tls12_score, exclude_no_dns_record_as_error, conn_server_lossy_zero_win_size_event_threshold, conn_lossy_total_rexmt_threshold, healthscore_max_server_limit, hs_pscore_traffic_threshold_l4_client, exclude_no_valid_gs_member_as_error, enable_advanced_analytics, hs_security_cipherscore_ge128b, uuid, exclude_invalid_dns_domain_as_error, exclude_http_error_codes, hs_max_anomaly_penalty, avi_api_patch_op, sip_log_depth, exclude_persistence_change_as_error, conn_server_lossy_ooo_threshold, hs_security_selfsignedcert_penalty, conn_server_lossy_total_rexmt_threshold, exclude_unsupported_dns_query_as_error, exclude_syn_retransmit_as_error, hs_security_hsts_penalty, apdex_rum_threshold, avi_api_update_method, conn_lossy_zero_win_size_event_threshold, hs_security_encalgo_score_rc4, name, apdex_rtt_threshold, disable_vs_analytics, tenant_ref, apdex_response_tolerated_factor, exclude_tcp_reset_as_error, hs_security_chain_invalidity_penalty, exclude_invalid_dns_query_as_error, conn_lossy_ooo_threshold, hs_security_cipherscore_lt128b, hs_security_encalgo_score_none, hs_event_throttle_window, apdex_rtt_tolerated_factor, hs_security_nonpfs_penalty, hs_security_certscore_gt30d, exclude_server_tcp_reset_as_error, hs_min_dos_rate, hs_max_resources_penalty, client_log_streaming_config, disable_ondemand_metrics, exclude_sip_error_codes, apdex_server_response_threshold, hs_performance_boost, client_log_config, exclude_gs_down_as_error, apdex_server_response_tolerated_factor, state, disable_server_analytics, conn_server_lossy_timeo_rexmt_threshold, exclude_client_close_before_request_as_error, hs_security_weak_signature_algo_penalty, conn_lossy_timeo_rexmt_threshold, ondemand_metrics_idle_timeout, hs_security_certscore_le30d, description, hs_security_ssl30_score, apdex_rum_tolerated_factor, hs_security_cipherscore_eq000b, ranges, apdex_server_rtt_threshold, exclude_server_dns_error_as_error, hs_security_tls11_score, resp_code_block, hs_security_certscore_le07d, hs_pscore_traffic_threshold_l4_server, hs_max_security_penalty, sensitive_log_profile, exclude_dns_policy_drop_as_significant, url, hs_security_tls10_score, hs_security_certscore_expired, apdex_response_threshold

This module is used to configure AnalyticsProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Api Session *arguments

Avi API Module

Arguments: data, http_method, params, timeout, path

This module can be used for calling any resources defined in Avi REST API. U(https://avinetworks.com/) This module is useful for invoking HTTP Patch methods and accessing resources that do not have an REST object associated with them.

Avi Api Version *arguments

Avi API Version Module

Arguments:

This module can be used to obtain the version of the Avi REST API. U(https://avinetworks.com/)

Avi Applicationpersistenceprofile *arguments

Module for setup of ApplicationPersistenceProfile Avi RESTful Object

Arguments: uuid, app_cookie_persistence_profile, state, persistence_type, name, tenant_ref, is_federated, server_hm_down_recovery, http_cookie_persistence_profile, url, avi_api_patch_op, ip_persistence_profile, hdr_persistence_profile, avi_api_update_method, description

This module is used to configure ApplicationPersistenceProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Applicationprofile *arguments

Module for setup of ApplicationProfile Avi RESTful Object

Arguments: description, state, http_profile, preserve_client_port, dos_rl_profile, preserve_client_ip, avi_api_update_method, name, tcp_app_profile, uuid, dns_service_profile, tenant_ref, sip_service_profile, created_by, url, avi_api_patch_op, cloud_config_cksum, type

This module is used to configure ApplicationProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Authprofile *arguments

Module for setup of AuthProfile Avi RESTful Object

Arguments: pa_agent_ref, http, uuid, saml, url, tenant_ref, state, name, avi_api_patch_op, tacacs_plus, ldap, type, avi_api_update_method, description

This module is used to configure AuthProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Autoscalelaunchconfig *arguments

Module for setup of AutoScaleLaunchConfig Avi RESTful Object

Arguments: uuid, mesos, url, tenant_ref, state, name, image_id, avi_api_patch_op, use_external_asg, openstack, avi_api_update_method, description

This module is used to configure AutoScaleLaunchConfig object more examples at U(https://github.com/avinetworks/devops)

Avi Backup *arguments

Module for setup of Backup Avi RESTful Object

Arguments: scheduler_ref, uuid, local_file_url, url, file_name, remote_file_url, tenant_ref, state, backup_config_ref, avi_api_patch_op, timestamp, avi_api_update_method

This module is used to configure Backup object more examples at U(https://github.com/avinetworks/devops)

Avi Backupconfiguration *arguments

Module for setup of BackupConfiguration Avi RESTful Object

Arguments: avi_api_update_method, aws_bucket_id, remote_directory, remote_hostname, backup_passphrase, aws_secret_access, upload_to_s3, ssh_user_ref, name, aws_access_key, uuid, url, tenant_ref, state, avi_api_patch_op, save_local, maximum_backups_stored, upload_to_remote_host, backup_file_prefix

This module is used to configure BackupConfiguration object more examples at U(https://github.com/avinetworks/devops)

Avi Certificatemanagementprofile *arguments

Module for setup of CertificateManagementProfile Avi RESTful Object

Arguments: name, url, tenant_ref, state, avi_api_patch_op, script_path, script_params, avi_api_update_method, uuid

This module is used to configure CertificateManagementProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Cloud *arguments

Module for setup of Cloud Avi RESTful Object

Arguments: vca_configuration, proxy_configuration, docker_configuration, oshiftk8s_configuration, autoscale_polling_interval, dhcp_enabled, rancher_configuration, vtype, uuid, linuxserver_configuration, custom_tags, state, gcp_configuration, nsx_configuration, avi_api_patch_op, apic_mode, dns_provider_ref, mesos_configuration, ip6_autocfg_enabled, openstack_configuration, enable_vip_static_routes, east_west_dns_provider_ref, ipam_provider_ref, cloudstack_configuration, avi_api_update_method, name, azure_configuration, license_tier, state_based_dns_registration, url, tenant_ref, mtu, east_west_ipam_provider_ref, obj_name_prefix, apic_configuration, prefer_static_routes, license_type, vcenter_configuration, aws_configuration

This module is used to configure Cloud object more examples at U(https://github.com/avinetworks/devops)

Avi Cloudconnectoruser *arguments

Module for setup of CloudConnectorUser Avi RESTful Object

Arguments: public_key, private_key, azure_serviceprincipal, name, url, tenant_ref, state, gcp_credentials, avi_api_patch_op, oci_credentials, azure_userpass, tencent_credentials, avi_api_update_method, uuid

This module is used to configure CloudConnectorUser object more examples at U(https://github.com/avinetworks/devops)

Avi Cloudproperties *arguments

Module for setup of CloudProperties Avi RESTful Object

Arguments: info, hyp_props, uuid, url, state, avi_api_patch_op, cc_props, cc_vtypes, avi_api_update_method

This module is used to configure CloudProperties object more examples at U(https://github.com/avinetworks/devops)

Avi Cluster *arguments

Module for setup of Cluster Avi RESTful Object

Arguments: uuid, name, url, tenant_ref, state, avi_api_patch_op, virtual_ip, nodes, avi_api_update_method, rejoin_nodes_automatically

This module is used to configure Cluster object more examples at U(https://github.com/avinetworks/devops)

Avi Clusterclouddetails *arguments

Module for setup of ClusterCloudDetails Avi RESTful Object

Arguments: name, url, tenant_ref, state, avi_api_patch_op, azure_info, avi_api_update_method, uuid

This module is used to configure ClusterCloudDetails object more examples at U(https://github.com/avinetworks/devops)

Avi Controllerproperties *arguments

Module for setup of ControllerProperties Avi RESTful Object

Arguments: vs_se_ping_fail, portal_token, cluster_ip_gratuitous_arp_period, persistence_key_rotate_period, bm_use_ansible, attach_ip_retry_interval, vs_se_vnic_fail, secure_channel_se_token_timeout, attach_ip_retry_limit, se_vnic_cooldown, vnic_op_fail_time, max_pcap_per_tenant, enable_memory_balancer, vs_se_bootup_fail, seupgrade_fabric_pool_size, cleanup_expired_authtoken_timeout_period, vs_key_rotate_period, seupgrade_segroup_min_dead_timeout, dns_refresh_period, max_dead_se_in_grp, upgrade_lease_time, warmstart_vs_resync_wait_time, avi_api_patch_op, se_create_timeout, query_host_fail, vs_apic_scaleout_timeout, unresponsive_se_reboot, state, process_pki_profile_timeout_period, se_offline_del, allow_ip_forwarding, upgrade_dns_ttl, fatal_error_lease_time, api_perf_logging_threshold, vs_se_attach_ip_fail, api_idle_timeout, max_seq_vnic_failures, allow_unauthenticated_nodes, allow_unauthenticated_apis, vs_scaleout_ready_check_interval, safenet_hsm_version, se_from_marketplace, warmstart_se_reconnect_wait_time, process_locked_useraccounts_timeout_period, consistency_check_timeout_period, avi_api_update_method, uuid, dummy, max_seq_attach_ip_failures, cleanup_sessions_timeout_period, secure_channel_cleanup_timeout, ssl_certificate_expiry_warning_days, vs_se_vnic_ip_fail, secure_channel_controller_token_timeout, url, vs_se_create_fail, cloud_reconcile, crashed_se_reboot, appviewx_compat_mode, vs_awaiting_se_timeout, enable_api_sharding, se_failover_attempt_interval, dead_se_detection_timer

This module is used to configure ControllerProperties object more examples at U(https://github.com/avinetworks/devops)

Avi Customipamdnsprofile *arguments

Module for setup of CustomIpamDnsProfile Avi RESTful Object

Arguments: name, url, tenant_ref, state, script_uri, avi_api_patch_op, script_params, avi_api_update_method, uuid

This module is used to configure CustomIpamDnsProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Dnspolicy *arguments

Module for setup of DnsPolicy Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, created_by, avi_api_patch_op, rule, avi_api_update_method, name

This module is used to configure DnsPolicy object more examples at U(https://github.com/avinetworks/devops)

Avi Errorpagebody *arguments

Module for setup of ErrorPageBody Avi RESTful Object

Arguments: name, format, url, tenant_ref, state, error_page_body, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure ErrorPageBody object more examples at U(https://github.com/avinetworks/devops)

Avi Errorpageprofile *arguments

Module for setup of ErrorPageProfile Avi RESTful Object

Arguments: uuid, error_pages, tenant_ref, state, name, url, avi_api_patch_op, company_name, host_name, avi_api_update_method, app_name

This module is used to configure ErrorPageProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Gslb *arguments

Module for setup of Gslb Avi RESTful Object

Arguments: description, state, maintenance_mode, view_id, sites, dns_configs, leader_cluster_uuid, async_interval, send_interval_prior_to_maintenance_mode, name, uuid, url, tenant_ref, is_federated, clear_on_max_retries, avi_api_patch_op, send_interval, avi_api_update_method, client_ip_addr_group, third_party_sites

This module is used to configure Gslb object more examples at U(https://github.com/avinetworks/devops)

Avi Gslbgeodbprofile *arguments

Module for setup of GslbGeoDbProfile Avi RESTful Object

Arguments: uuid, state, url, tenant_ref, is_federated, name, avi_api_patch_op, entries, avi_api_update_method, description

This module is used to configure GslbGeoDbProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Gslbservice *arguments

Module for setup of GslbService Avi RESTful Object

Arguments: hm_off, description, wildcard_match, application_persistence_profile_ref, enabled, domain_names, is_federated, use_edns_client_subnet, groups, ttl, health_monitor_scope, avi_api_update_method, name, controller_health_status_enabled, uuid, url, down_response, tenant_ref, avi_api_patch_op, created_by, health_monitor_refs, state, site_persistence_enabled, min_members, pool_algorithm, num_dns_ip

This module is used to configure GslbService object more examples at U(https://github.com/avinetworks/devops)

Avi Gslbservice Patch Member *arguments

Avi API Module

Arguments: data, state, params, name

This module can be used for calling any resources defined in Avi REST API. U(https://avinetworks.com/) This module is useful for invoking HTTP Patch methods and accessing resources that do not have an REST object associated with them.

Avi Hardwaresecuritymodulegroup *arguments

Module for setup of HardwareSecurityModuleGroup Avi RESTful Object

Arguments: name, url, tenant_ref, state, hsm, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure HardwareSecurityModuleGroup object more examples at U(https://github.com/avinetworks/devops)

Avi Healthmonitor *arguments

Module for setup of HealthMonitor Avi RESTful Object

Arguments: https_monitor, receive_timeout, description, radius_monitor, is_federated, udp_monitor, http_monitor, avi_api_update_method, successful_checks, monitor_port, sip_monitor, uuid, url, dns_monitor, tenant_ref, avi_api_patch_op, name, failed_checks, tcp_monitor, state, send_interval, external_monitor, type

This module is used to configure HealthMonitor object more examples at U(https://github.com/avinetworks/devops)

Avi Httppolicyset *arguments

Module for setup of HTTPPolicySet Avi RESTful Object

Arguments: is_internal_policy, uuid, url, tenant_ref, state, created_by, name, avi_api_patch_op, cloud_config_cksum, http_security_policy, http_request_policy, http_response_policy, avi_api_update_method, description

This module is used to configure HTTPPolicySet object more examples at U(https://github.com/avinetworks/devops)

Avi Ipaddrgroup *arguments

Module for setup of IpAddrGroup Avi RESTful Object

Arguments: description, marathon_service_port, ranges, addrs, avi_api_update_method, uuid, country_codes, name, url, tenant_ref, state, apic_epg_name, prefixes, avi_api_patch_op, marathon_app_name, ip_ports

This module is used to configure IpAddrGroup object more examples at U(https://github.com/avinetworks/devops)

Avi Ipamdnsproviderprofile *arguments

Module for setup of IpamDnsProviderProfile Avi RESTful Object

Arguments: state, proxy_configuration, infoblox_profile, allocate_ip_in_vrf, oci_profile, internal_profile, aws_profile, tencent_profile, avi_api_update_method, uuid, azure_profile, openstack_profile, name, gcp_profile, url, tenant_ref, custom_profile, avi_api_patch_op, type

This module is used to configure IpamDnsProviderProfile object more examples at U(https://github.com/avinetworks/devops)

Avi L4policyset *arguments

Module for setup of L4PolicySet Avi RESTful Object

Arguments: l4_connection_policy, uuid, url, tenant_ref, state, created_by, name, avi_api_patch_op, is_internal_policy, avi_api_update_method, description

This module is used to configure L4PolicySet object more examples at U(https://github.com/avinetworks/devops)

Avi Microservicegroup *arguments

Module for setup of MicroServiceGroup Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, created_by, avi_api_patch_op, service_refs, avi_api_update_method, name

This module is used to configure MicroServiceGroup object more examples at U(https://github.com/avinetworks/devops)

Avi Network *arguments

Module for setup of Network Avi RESTful Object

Arguments: exclude_discovered_subnets, ip6_autocfg_enabled, vrf_context_ref, vcenter_dvs, uuid, configured_subnets, name, vimgrnw_ref, cloud_ref, tenant_ref, state, synced_from_se, dhcp_enabled, url, avi_api_patch_op, avi_api_update_method

This module is used to configure Network object more examples at U(https://github.com/avinetworks/devops)

Avi Networkprofile *arguments

Module for setup of NetworkProfile Avi RESTful Object

Arguments: profile, uuid, url, description, tenant_ref, state, avi_api_patch_op, connection_mirror, avi_api_update_method, name

This module is used to configure NetworkProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Networksecuritypolicy *arguments

Module for setup of NetworkSecurityPolicy Avi RESTful Object

Arguments: uuid, rules, tenant_ref, state, created_by, name, url, avi_api_patch_op, cloud_config_cksum, avi_api_update_method, description

This module is used to configure NetworkSecurityPolicy object more examples at U(https://github.com/avinetworks/devops)

Avi Pkiprofile *arguments

Module for setup of PKIProfile Avi RESTful Object

Arguments: crls, name, state, url, ignore_peer_chain, tenant_ref, is_federated, created_by, ca_certs, avi_api_patch_op, validate_only_leaf_crl, crl_check, avi_api_update_method, uuid

This module is used to configure PKIProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Pool *arguments

Module for setup of Pool Avi RESTful Object

Arguments: host_check_enabled, delete_server_on_dns_refresh, capacity_estimation, servers, capacity_estimation_ttfb_thresh, fewest_tasks_feedback_delay, server_auto_scale, ipaddrgroup_ref, lookup_server_by_name, networks, lb_algorithm_hash, analytics_profile_ref, uuid, server_name, autoscale_policy_ref, ssl_profile_ref, created_by, apic_epg_name, application_persistence_profile_ref, inline_health_monitor, request_queue_depth, server_reselect, ab_priority, ssl_key_and_certificate_ref, avi_api_update_method, name, autoscale_launch_config_ref, tenant_ref, autoscale_networks, health_monitor_refs, min_health_monitors_up, external_autoscale_groups, vrf_ref, gslb_sp_enabled, lb_algorithm, use_service_port, rewrite_host_header_to_server_name, lb_algorithm_core_nonaffinity, conn_pool_properties, rewrite_host_header_to_sni, max_conn_rate_per_server, ab_pool, min_servers_up, fail_action, service_metadata, sni_enabled, cloud_ref, domain_name, east_west, placement_networks, graceful_disable_timeout, state, nsx_securitygroup, a_pool, pki_profile_ref, analytics_policy, default_server_port, description, enabled, avi_api_patch_op, server_timeout, request_queue_enabled, max_concurrent_connections_per_server, url, prst_hdr_name, server_count, lb_algorithm_consistent_hash_hdr, connection_ramp_duration, cloud_config_cksum

This module is used to configure Pool object more examples at U(https://github.com/avinetworks/devops)

Avi Poolgroup *arguments

Module for setup of PoolGroup Avi RESTful Object

Arguments: description, implicit_priority_labels, members, fail_action, service_metadata, avi_api_update_method, name, priority_labels_ref, uuid, cloud_ref, tenant_ref, state, created_by, url, avi_api_patch_op, cloud_config_cksum, min_servers, deployment_policy_ref

This module is used to configure PoolGroup object more examples at U(https://github.com/avinetworks/devops)

Avi Poolgroupdeploymentpolicy *arguments

Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object

Arguments: target_test_traffic_ratio, evaluation_duration, description, test_traffic_ratio_rampup, rules, auto_disable_old_prod_pools, tenant_ref, state, name, url, avi_api_patch_op, webhook_ref, scheme, avi_api_update_method, uuid

This module is used to configure PoolGroupDeploymentPolicy object more examples at U(https://github.com/avinetworks/devops)

Avi Prioritylabels *arguments

Module for setup of PriorityLabels Avi RESTful Object

Arguments: uuid, cloud_ref, tenant_ref, state, name, url, avi_api_patch_op, equivalent_labels, avi_api_update_method, description

This module is used to configure PriorityLabels object more examples at U(https://github.com/avinetworks/devops)

Avi Role *arguments

Module for setup of Role Avi RESTful Object

Arguments: name, url, privileges, tenant_ref, state, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure Role object more examples at U(https://github.com/avinetworks/devops)

Avi Scheduler *arguments

Module for setup of Scheduler Avi RESTful Object

Arguments: state, enabled, backup_config_ref, frequency, scheduler_action, end_date_time, avi_api_update_method, uuid, start_date_time, name, url, tenant_ref, frequency_unit, avi_api_patch_op, run_script_ref, run_mode

This module is used to configure Scheduler object more examples at U(https://github.com/avinetworks/devops)

Avi Seproperties *arguments

Module for setup of SeProperties Avi RESTful Object

Arguments: se_agent_properties, uuid, url, se_runtime_properties, state, avi_api_patch_op, se_bootup_properties, avi_api_update_method

This module is used to configure SeProperties object more examples at U(https://github.com/avinetworks/devops)

Avi Serverautoscalepolicy *arguments

Module for setup of ServerAutoScalePolicy Avi RESTful Object

Arguments: use_predicted_load, intelligent_autoscale, description, intelligent_scaleout_margin, scaleout_alertconfig_refs, min_size, scalein_cooldown, scaleout_cooldown, max_size, name, intelligent_scalein_margin, uuid, url, tenant_ref, state, max_scalein_adjustment_step, avi_api_patch_op, scalein_alertconfig_refs, avi_api_update_method, max_scaleout_adjustment_step

This module is used to configure ServerAutoScalePolicy object more examples at U(https://github.com/avinetworks/devops)

Avi Serviceengine *arguments

Module for setup of ServiceEngine Avi RESTful Object

Arguments: enable_state, mgmt_vnic, tenant_ref, controller_created, flavor, avi_api_update_method, uuid, name, cloud_ref, hypervisor, se_group_ref, container_mode, data_vnics, state, container_type, host_ref, url, avi_api_patch_op, availability_zone, controller_ip, resources

This module is used to configure ServiceEngine object more examples at U(https://github.com/avinetworks/devops)

Avi Serviceenginegroup *arguments

Module for setup of ServiceEngineGroup Avi RESTful Object

Arguments: disable_tso, host_attribute_value, async_ssl, instance_flavor, auto_redistribute_active_standby_load, disable_avi_securitygroups, self_se_election, free_list_size, bgp_state_update_interval, uuid, vs_scalein_timeout, se_udp_encap_ipc, min_cpu_usage, custom_securitygroups_data, ingress_access_data, vcenter_clusters, max_rules_per_lb, iptables, num_dispatcher_cores, connection_memory_percentage, service_ip_subnets, placement_mode, max_scaleout_per_vs, enable_routing, waf_mempool, per_app, se_pcap_lookahead, vcenter_datastores_include, se_name_prefix, waf_learning_memory, name, tenant_ref, max_se, license_type, se_flow_probe_timer, se_dos_profile, disable_se_memory_check, datascript_timeout, udf_log_throttle, vcenter_hosts, vcpus_per_se, cpu_socket_affinity, realtime_se_metrics, config_debugs_on_all_cores, se_dpdk_pmd, memory_for_config_update, custom_tag, non_significant_log_throttle, shm_minimum_config_memory, extra_shared_config_memory, vcenter_datastores, state, se_sb_threads, active_standby, waf_learning_interval, auto_rebalance_capacity_per_se, service_ip6_subnets, reboot_on_stop, se_probe_port, extra_config_multiplier, distribute_load_active_standby, async_ssl_threads, advertise_backend_networks, vcenter_folder, floating_intf_ip, heap_minimum_config_memory, max_memory_per_mempool, ssl_preprocess_sni_hostname, allow_burst, max_cpu_usage, min_scaleout_per_vs, vss_placement, buffer_se, mem_reserve, vcenter_datastore_mode, enable_hsm_priming, auto_rebalance_criteria, least_load_core_selection, aggressive_failure_detection, significant_log_throttle, se_bandwidth_type, additional_config_memory, vs_se_scaleout_additional_wait_time, max_public_ips_per_lb, accelerated_networking, enable_vip_on_all_interfaces, se_routing, auto_rebalance, data_network_id, min_se, se_tunnel_mode, memory_per_se, se_tunnel_udp_port, disable_gro, vs_scaleout_timeout, se_flow_probe_retries, ephemeral_portrange_end, ha_mode, se_remote_punt_udp_port, ingress_access_mgmt, disk_per_se, vs_se_scaleout_ready_timeout, archive_shm_limit, max_vs_per_se, app_learning_memory_percent, enable_multi_lb, openstack_mgmt_network_uuid, n_log_streaming_threads, use_standard_alb, avi_api_update_method, se_vs_hb_max_pkts_in_batch, app_cache_percent, se_sb_dedicated_core, host_attribute_key, se_ipc_udp_port, hypervisor, cpu_reserve, custom_securitygroups_mgmt, enable_vmac, openstack_mgmt_network_name, se_pcap_reinit_threshold, hm_on_standby, distribute_queues, hardwaresecuritymodulegroup_ref, minimum_required_config_memory, ephemeral_portrange_start, se_tracert_port_range, floating_intf_ip_se_2, log_disksz, se_use_dpdk, openstack_availability_zone, auto_rebalance_interval, avi_api_patch_op, vip_asg, ignore_rtt_threshold, openstack_availability_zones, disable_csum_offloads, num_flow_cores_sum_changes_to_ignore, algo, os_reserved_memory, se_pcap_reinit_frequency, description, vs_scalein_timeout_for_upgrade, se_deprovision_delay, se_vs_hb_max_vs_in_pkt, minimum_connection_memory, mgmt_network_ref, license_tier, flow_table_new_syn_max_entries, host_gateway_monitor, url, cloud_ref, vs_switchover_timeout, se_thread_multiplier, waf_mempool_size, dedicated_dispatcher_core, mgmt_subnet, vs_host_redundancy, vss_placement_enabled

This module is used to configure ServiceEngineGroup object more examples at U(https://github.com/avinetworks/devops)

Avi Snmptrapprofile *arguments

Module for setup of SnmpTrapProfile Avi RESTful Object

Arguments: name, trap_servers, tenant_ref, state, url, avi_api_patch_op, avi_api_update_method, uuid

This module is used to configure SnmpTrapProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Sslkeyandcertificate *arguments

Module for setup of SSLKeyAndCertificate Avi RESTful Object

Arguments: status, certificate_management_profile_ref, key_base64, key_passphrase, hardwaresecuritymodulegroup_ref, key, certificate_base64, key_params, avi_api_update_method, name, enckey_base64, dynamic_params, uuid, certificate, url, enckey_name, format, tenant_ref, avi_api_patch_op, created_by, state, ca_certs, type

This module is used to configure SSLKeyAndCertificate object more examples at U(https://github.com/avinetworks/devops)

Avi Sslprofile *arguments

Module for setup of SSLProfile Avi RESTful Object

Arguments: accepted_ciphers, prefer_client_cipher_ordering, description, tags, accepted_versions, state, avi_api_update_method, name, ssl_session_timeout, uuid, url, ssl_rating, tenant_ref, avi_api_patch_op, enable_ssl_session_reuse, cipher_enums, send_close_notify, dhparam, type

This module is used to configure SSLProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Stringgroup *arguments

Module for setup of StringGroup Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, avi_api_patch_op, kv, type, avi_api_update_method, name

This module is used to configure StringGroup object more examples at U(https://github.com/avinetworks/devops)

Avi Systemconfiguration *arguments

Module for setup of SystemConfiguration Avi RESTful Object

Arguments: secure_channel_configuration, docker_mode, welcome_workflow_complete, global_tenant_config, proxy_configuration, ssh_hmacs, linux_configuration, portal_configuration, avi_api_update_method, email_configuration, uuid, snmp_configuration, url, default_license_tier, dns_configuration, avi_api_patch_op, dns_virtualservice_refs, state, ntp_configuration, admin_auth_configuration, mgmt_ip_access_control, ssh_ciphers

This module is used to configure SystemConfiguration object more examples at U(https://github.com/avinetworks/devops)

Avi Tenant *arguments

Module for setup of Tenant Avi RESTful Object

Arguments: uuid, url, state, created_by, name, avi_api_patch_op, config_settings, local, avi_api_update_method, description

This module is used to configure Tenant object more examples at U(https://github.com/avinetworks/devops)

Avi Trafficcloneprofile *arguments

Module for setup of TrafficCloneProfile Avi RESTful Object

Arguments: uuid, cloud_ref, tenant_ref, state, url, avi_api_patch_op, clone_servers, preserve_client_ip, avi_api_update_method, name

This module is used to configure TrafficCloneProfile object more examples at U(https://github.com/avinetworks/devops)

Avi User *arguments

Avi User Module

Arguments: user_profile_ref, name, state, is_active, avi_api_patch_op, email, access, is_superuser, obj_username, avi_api_update_method, obj_password, default_tenant_ref

This module can be used for creation, updation and deletion of a user.

Avi Useraccount *arguments

Avi UserAccount Module

Arguments: force_change, old_password

This module can be used for updating the password of a user. This module is useful for setting up admin password for Controller bootstrap.

Avi Useraccountprofile *arguments

Module for setup of UserAccountProfile Avi RESTful Object

Arguments: max_concurrent_sessions, uuid, state, url, account_lock_timeout, avi_api_patch_op, max_login_failure_count, max_password_history_count, credentials_timeout_threshold, avi_api_update_method, name

This module is used to configure UserAccountProfile object more examples at U(https://github.com/avinetworks/devops)

Avi Virtualservice *arguments

Module for setup of VirtualService Avi RESTful Object

Arguments: client_auth, port_uuid, ssl_profile_selectors, availability_zone, error_page_profile_ref, subnet_uuid, delay_fairness, vip, static_dns_records, enable_rhi_snat, sideband_profile, requests_rate_limit, analytics_profile_ref, uuid, ipam_network_subnet, server_network_profile_ref, description, ssl_profile_ref, created_by, topology_policies, max_cps_per_client, pool_group_ref, traffic_enabled, ssl_sess_cache_avg_size, flow_dist, l4_policies, http_policies, application_profile_ref, microservice_ref, use_vip_as_snat, discovered_network_ref, ip_address, azure_availability_set, avi_api_update_method, east_west_placement, floating_subnet_uuid, name, service_pool_select, close_client_conn_on_config_update, type, enable_autogw, discovered_networks, tenant_ref, remove_listening_port_on_vs_down, ssl_key_and_certificate_refs, snat_ip, host_name_xlate, analytics_policy, sp_pool_refs, flow_label_type, network_profile_ref, weight, dns_info, vh_domain_name, security_policy_ref, content_rewrite, traffic_clone_profile_ref, apic_contract_graph, avi_allocated_vip, vrf_context_ref, allow_invalid_client_cert, subnet, service_metadata, cloud_type, network_ref, cloud_ref, enable_rhi, saml_sp_config, waf_policy_ref, dns_policies, scaleout_ecmp, sso_policy, state, nsx_securitygroup, cloud_config_cksum, min_pools_up, vsvip_ref, performance_limits, use_bridge_ip_as_vip, enabled, floating_ip, auto_allocate_floating_ip, avi_api_patch_op, vh_parent_vs_uuid, connections_rate_limit, active_standby_se_tag, pool_ref, ign_pool_net_reach, limit_doser, url, auto_allocate_ip, fqdn, network_security_policy_ref, vs_datascripts, services, avi_allocated_fip, sso_policy_ref, vsvip_cloud_config_cksum, discovered_subnet, se_group_ref, bulk_sync_kvcache

This module is used to configure VirtualService object more examples at U(https://github.com/avinetworks/devops)

Avi Vrfcontext *arguments

Module for setup of VrfContext Avi RESTful Object

Arguments: uuid, static_routes, cloud_ref, tenant_ref, state, name, url, avi_api_patch_op, system_default, avi_api_update_method, gateway_mon, internal_gateway_monitor, debugvrfcontext, bgp_profile, description

This module is used to configure VrfContext object more examples at U(https://github.com/avinetworks/devops)

Avi Vsdatascriptset *arguments

Module for setup of VSDataScriptSet Avi RESTful Object

Arguments: datascript, uuid, pool_refs, state, url, pool_group_refs, protocol_parser_refs, tenant_ref, string_group_refs, created_by, ipgroup_refs, avi_api_patch_op, name, avi_api_update_method, description

This module is used to configure VSDataScriptSet object more examples at U(https://github.com/avinetworks/devops)

Avi Vsvip *arguments

Module for setup of VsVip Avi RESTful Object

Arguments: east_west_placement, vrf_context_ref, name, state, cloud_ref, dns_info, tenant_ref, avi_api_patch_op, url, vip, vsvip_cloud_config_cksum, use_standard_alb, avi_api_update_method, uuid

This module is used to configure VsVip object more examples at U(https://github.com/avinetworks/devops)

Avi Webhook *arguments

Module for setup of Webhook Avi RESTful Object

Arguments: uuid, url, description, tenant_ref, state, verification_token, avi_api_patch_op, callback_url, avi_api_update_method, name

This module is used to configure Webhook object more examples at U(https://github.com/avinetworks/devops)

Awall *arguments

Manage awall policies

Arguments: state, activate, name

This modules allows for enable/disable/activate of I(awall) policies. Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files and activates the configuration on the system.

Aws Acm Info *arguments

Retrieve certificate information from AWS Certificate Manager service

Arguments: domain_name, statuses

Retrieve information for ACM certificates This module was called C(aws_acm_facts) before Ansible 2.9. The usage did not change.

Aws Api Gateway *arguments

Manage AWS API Gateway APIs

Arguments: swagger_file, state, swagger_text, swagger_dict, deploy_desc, api_id, stage

Allows for the management of API Gateway APIs Normally you should give the api_id since there is no other stable guaranteed unique identifier for the API. If you do not give api_id then a new API will be create each time this is run. Beware that there are very hard limits on the rate that you can call API Gateway's REST API. You may need to patch your boto. See https://github.com/boto/boto3/issues/876 and discuss with your AWS rep. swagger_file and swagger_text are passed directly on to AWS transparently whilst swagger_dict is an ansible dict which is converted to JSON before the API definitions are uploaded.

Aws Application Scaling Policy *arguments

Manage Application Auto Scaling Scaling Policies

Arguments: policy_type, minimum_tasks, resource_id, target_tracking_scaling_policy_configuration, step_scaling_policy_configuration, scalable_dimension, service_namespace, override_task_capacity, policy_name, maximum_tasks

Creates, updates or removes a Scaling Policy

Aws Az Info *arguments

Gather information about availability zones in AWS.

Arguments: filters

Gather information about availability zones in AWS. This module was called C(aws_az_facts) before Ansible 2.9. The usage did not change.

Aws Batch Compute Environment *arguments

Manage AWS Batch Compute Environments

Arguments: subnets, tags, instance_types, bid_percentage, image_id, maxv_cpus, security_group_ids, instance_role, desiredv_cpus, minv_cpus, compute_resource_type, compute_environment_state, state, spot_iam_fleet_role, service_role, compute_environment_name, type, ec2_key_pair

This module allows the management of AWS Batch Compute Environments. It is idempotent and supports "Check" mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Aws Batch Job Definition *arguments

Manage AWS Batch Job Definitions

Arguments: readonly_root_filesystem, mount_points, image, job_role_arn, attempts, user, job_definition_arn, parameters, state, environment, vcpus, command, volumes, memory, job_definition_name, type, privileged, ulimits

This module allows the management of AWS Batch Job Definitions. It is idempotent and supports "Check" mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Aws Batch Job Queue *arguments

Manage AWS Batch Job Queues

Arguments: priority, compute_environment_order, state, job_queue_name, job_queue_state

This module allows the management of AWS Batch Job Queues. It is idempotent and supports "Check" mode. Use module M(aws_batch_compute_environment) to manage the compute environment, M(aws_batch_job_queue) to manage job queues, M(aws_batch_job_definition) to manage job definitions.

Aws Caller Info *arguments

Get information about the user and account being used to make AWS calls.

Arguments:

This module returns information about the account and user / role from which the AWS access tokens originate. The primary use of this is to get the account id for templating into ARNs or similar to avoid needing to specify this information in inventory. This module was called C(aws_caller_facts) before Ansible 2.9. The usage did not change.

Aws Codebuild *arguments

Create or delete an AWS CodeBuild project

Arguments: environment, name, tags, artifacts, cache, encryption_key, vpc_config, source, state, service_role, timeout_in_minutes, description

Create or delete a CodeBuild projects on AWS, used for building code artifacts from source code.

Aws Codecommit *arguments

Manage repositories in AWS CodeCommit

Arguments: comment, state, name

Supports creation and deletion of CodeCommit repositories. See U(https://aws.amazon.com/codecommit/) for more information about CodeCommit.

Aws Codepipeline *arguments

Create or delete AWS CodePipelines

Arguments: state, version, role_arn, name, stages, artifact_store

Create or delete a CodePipeline on AWS.

Aws Config Aggregation Authorization *arguments

Manage cross-account AWS Config authorizations

Arguments: authorized_account_id, authorized_aws_region, state

Module manages AWS Config resources

Aws Config Aggregator *arguments

Manage AWS Config aggregations across multiple accounts

Arguments: account_sources, state, organization_source, name

Module manages AWS Config resources

Aws Config Delivery Channel *arguments

Manage AWS Config delivery channels

Arguments: state, s3_prefix, name, delivery_frequency, s3_bucket, sns_topic_arn

This module manages AWS Config delivery locations for rule checks and configuration info

Aws Config Recorder *arguments

Manage AWS Config Recorders

Arguments: state, role_arn, recording_group, name

Module manages AWS Config configuration recorder settings

Aws Config Rule *arguments

Manage AWS Config resources

Arguments: source, execution_frequency, name, input_parameters, scope, state, description

Module manages AWS Config rules

Aws Direct Connect Connection *arguments

Creates, deletes, modifies a DirectConnect connection

Arguments: forced_update, bandwidth, name, state, link_aggregation_group, connection_id, location

Create, update, or delete a Direct Connect connection between a network and a specific AWS Direct Connect location. Upon creation the connection may be added to a link aggregation group or established as a standalone connection. The connection may later be associated or disassociated with a link aggregation group.

Aws Direct Connect Gateway *arguments

Manage AWS Direct Connect Gateway.

Arguments: direct_connect_gateway_id, state, virtual_gateway_id, name, amazon_asn

Creates AWS Direct Connect Gateway Deletes AWS Direct Connect Gateway Attaches Virtual Gateways to Direct Connect Gateway Detaches Virtual Gateways to Direct Connect Gateway

Aws Direct Connect Link Aggregation Group *arguments

Manage Direct Connect LAG bundles.

Arguments: name, state, delete_with_disassociation, force_delete, num_connections, connection_id, bandwidth, wait_timeout, location, min_links, link_aggregation_group_id, wait

Create, delete, or modify a Direct Connect link aggregation group.

Aws Direct Connect Virtual Interface *arguments

Manage Direct Connect virtual interfaces.

Arguments: vlan, name, virtual_interface_id, id_to_associate, customer_address, state, amazon_address, authentication_key, bgp_asn, cidr, address_type, virtual_gateway_id, public

Create, delete, or modify a Direct Connect public or private virtual interface.

Aws Eks Cluster *arguments

Manage Elastic Kubernetes Service Clusters

Arguments: subnets, role_arn, name, state, wait_timeout, version, security_groups, wait

Manage Elastic Kubernetes Service Clusters

Aws Elasticbeanstalk App *arguments

create, update, and delete an elastic beanstalk application

Arguments: state, description, terminate_by_force, app_name

creates, updates, deletes beanstalk applications if app_name is provided

Aws Glue Connection *arguments

Manage an AWS Glue connection

Arguments: connection_type, connection_properties, name, match_criteria, subnet_id, state, catalog_id, security_groups, description

Manage an AWS Glue connection. See U(https://aws.amazon.com/glue/) for details.

Aws Glue Job *arguments

Manage an AWS Glue job

Arguments: description, allocated_capacity, max_concurrent_runs, max_retries, connections, state, default_arguments, role, timeout, command_name, command_script_location, name

Manage an AWS Glue job. See U(https://aws.amazon.com/glue/) for details.

Aws Inspector Target *arguments

Create, Update and Delete Amazon Inspector Assessment Targets

Arguments: state, name, tags

Creates, updates, or deletes Amazon Inspector Assessment Targets and manages the required Resource Groups.

Aws Kms *arguments

Perform various KMS management tasks.

Arguments: alias, policy_grant_types, description, tags, purge_tags, enabled, policy_clean_invalid_entries, state, grants, key_id, policy, purge_grants, policy_role_name, policy_role_arn, policy_mode

Manage role/user access to a KMS key. Not designed for encrypting/decrypting.

Aws Kms Info *arguments

Gather information about AWS KMS keys

Arguments: pending_deletion, filters

Gather information about AWS KMS keys including tags and grants This module was called C(aws_kms_facts) before Ansible 2.9. The usage did not change.

Aws Netapp Cvs Active Directory *arguments

NetApp AWS CloudVolumes Service Manage Active Directory.

Arguments: username, domain, DNS, region, password, state, netBIOS

Create, Update, Delete ActiveDirectory on AWS Cloud Volumes Service.

Aws Netapp Cvs FileSystems *arguments

NetApp AWS Cloud Volumes Service Manage FileSystem.

Arguments: state, quotaInBytes, exportPolicy, creationToken, region, serviceLevel

Create, Update, Delete fileSystem on AWS Cloud Volumes Service.

Aws Netapp Cvs Pool *arguments

NetApp AWS Cloud Volumes Service Manage Pools.

Arguments: sizeInBytes, vendorID, state, from_name, name, region, serviceLevel

Create, Update, Delete Pool on AWS Cloud Volumes Service.

Aws Netapp Cvs Snapshots *arguments

NetApp AWS Cloud Volumes Service Manage Snapshots.

Arguments: region, fileSystemId, from_name, state, name

Create, Update, Delete Snapshot on AWS Cloud Volumes Service.

Aws Region Info *arguments

Gather information about AWS regions.

Arguments: filters

Gather information about AWS regions. This module was called C(aws_region_facts) before Ansible 2.9. The usage did not change.

Aws S3 *arguments

manage objects in S3.

Arguments: encryption_kms_key_id, permission, dest, object, encryption_mode, prefix, marker, ignore_nonexistent_bucket, dualstack, overwrite, headers, aws_secret_key, src, aws_access_key, encrypt, rgw, region, bucket, retries, max_keys, version, expiration, s3_url, metadata, mode

This module allows the user to manage S3 buckets and the objects within them. Includes support for creating and deleting both objects and buckets, retrieving objects as files or strings and generating download links. This module has a dependency on boto3 and botocore.

Aws S3 Bucket Info *arguments

Lists S3 buckets in AWS

Arguments:

Lists S3 buckets in AWS This module was called C(aws_s3_bucket_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(aws_s3_bucket_info) module no longer returns C(ansible_facts)!

Aws S3 Cors *arguments

Manage CORS for S3 buckets in AWS

Arguments: rules, state, name

Manage CORS for S3 buckets in AWS

Aws Secret *arguments

Manage secrets stored in AWS Secrets Manager.

Arguments: secret_type, kms_key_id, name, rotation_interval, tags, state, secret, recovery_window, rotation_lambda, description

Create, update, and delete secrets stored in AWS Secrets Manager.

Aws Ses Identity *arguments

Manages SES email and domain identity

Arguments: bounce_notifications, state, delivery_notifications, feedback_forwarding, complaint_notifications, identity

This module allows the user to manage verified email and domain identity for SES. This covers verifying and removing identities as well as setting up complaint, bounce and delivery notification settings.

Aws Ses Identity Policy *arguments

Manages SES sending authorization policies

Arguments: policy, state, identity, policy_name

This module allows the user to manage sending authorization policies associated with an SES identity (email or domain). SES authorization sending policies can be used to control what actors are able to send email on behalf of the validated identity and what conditions must be met by the sent emails.

Aws Ses Rule Set *arguments

Manages SES inbound receipt rule sets

Arguments: active, state, force, name

The M(aws_ses_rule_set) module allows you to create, delete, and manage SES receipt rule sets

Aws Sgw Info *arguments

Fetch AWS Storage Gateway information

Arguments: gather_local_disks, gather_file_shares, gather_tapes, gather_volumes

Fetch AWS Storage Gateway information This module was called C(aws_sgw_facts) before Ansible 2.9. The usage did not change.

Aws Ssm Parameter Store *arguments

Manage key-value pairs in aws parameter store.

Arguments: decryption, name, region, string_type, value, state, key_id, overwrite_value, description

Manage key-value pairs in aws parameter store.

Aws Waf Condition *arguments

create and delete WAF Conditions

Arguments: state, name, filters, purge_filters, type, waf_regional

Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/)

Aws Waf Info *arguments

Retrieve information for WAF ACLs, Rule , Conditions and Filters.

Arguments: name, waf_regional

Retrieve information for WAF ACLs, Rule , Conditions and Filters. This module was called C(aws_waf_facts) before Ansible 2.9. The usage did not change.

Aws Waf Rule *arguments

create and delete WAF Rules

Arguments: state, name, purge_conditions, conditions, waf_regional, metric_name

Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/)

Aws Waf Web Acl *arguments

create and delete WAF Web ACLs

Arguments: state, metric_name, purge_rules, rules, default_action, waf_regional, name

Read the AWS documentation for WAF U(https://aws.amazon.com/documentation/waf/)

Azure Rm Acs *arguments

Manage an Azure Container Service(ACS) instance

Arguments: linux_profile, master_profile, name, resource_group, orchestration_platform, agent_pool_profiles, state, location, service_principal, diagnostics_profile

Create, update and delete an Azure Container Service(ACS) instance.

Azure Rm Aks *arguments

Manage a managed Azure Container Service (AKS) instance

Arguments: linux_profile, kubernetes_version, name, resource_group, agent_pool_profiles, enable_rbac, state, network_profile, location, aad_profile, service_principal, dns_prefix, addon

Create, update and delete a managed Azure Container Service (AKS) instance.

Azure Rm Aks Info *arguments

Get Azure Kubernetes Service facts

Arguments: show_kubeconfig, name, resource_group, tags

Get facts for a specific Azure Kubernetes Service or all Azure Kubernetes Services.

Azure Rm Aksversion Info *arguments

Get available kubernetes versions supported by Azure Kubernetes Service

Arguments: version, location

Get available kubernetes versions supported by Azure Kubernetes Service.

Azure Rm Appgateway *arguments

Manage Application Gateway instance

Arguments: backend_http_settings_collection, authentication_certificates, ssl_policy, resource_group, redirect_configurations, request_routing_rules, probes, sku, name, ssl_certificates, backend_address_pools, frontend_ip_configurations, state, http_listeners, location, gateway_ip_configurations, frontend_ports

Create, update and delete instance of Application Gateway.

Azure Rm Applicationsecuritygroup *arguments

Manage Azure Application Security Group

Arguments: state, name, resource_group, location

Create, update and delete instance of Azure Application Security Group.

Azure Rm Applicationsecuritygroup Info *arguments

Get Azure Application Security Group facts

Arguments: name, resource_group, tags

Get facts of Azure Application Security Group.

Azure Rm Appserviceplan *arguments

Manage App Service Plan

Arguments: sku, number_of_workers, state, name, resource_group, is_linux, location

Create, update and delete instance of App Service Plan.

Azure Rm Appserviceplan Info *arguments

Get azure app service plan facts

Arguments: name, resource_group, tags

Get facts for a specific app service plan or all app service plans in a resource group, or all app service plan in current subscription.

Azure Rm Automationaccount *arguments

Manage Azure Automation account

Arguments: state, name, resource_group, location

Create, delete an Azure Automation account.

Azure Rm Automationaccount Info *arguments

Get Azure automation account facts

Arguments: list_usages, list_statistics, list_keys, name, resource_group, tags

Get facts of automation account.

Azure Rm Autoscale *arguments

Manage Azure autoscale setting

Arguments: target, resource_group, enabled, profiles, notifications, state, location, name

Create, delete an autoscale setting.

Azure Rm Autoscale Info *arguments

Get Azure Auto Scale Setting facts

Arguments: name, resource_group, tags

Get facts of Auto Scale Setting.

Azure Rm Availabilityset *arguments

Manage Azure Availability Set

Arguments: sku, platform_fault_domain_count, state, name, resource_group, platform_update_domain_count, location

Create, update and delete Azure Availability Set. An availability set cannot be updated, you will have to recreate one instead. The only update operation will be for the tags.

Azure Rm Availabilityset Info *arguments

Get Azure Availability Set facts

Arguments: name, resource_group, tags

Get facts for a specific availability set or all availability sets.

Azure Rm Azurefirewall *arguments

Manage Azure Firewall instance.

Arguments: name, resource_group, nat_rule_collections, network_rule_collections, application_rule_collections, state, location, ip_configurations

Create, update and delete instance of Azure Firewall.

Azure Rm Azurefirewall Info *arguments

Get AzureFirewall info.

Arguments: name, resource_group

Get info of AzureFirewall.

Azure Rm Batchaccount *arguments

Manages a Batch Account on Azure.

Arguments: state, pool_allocation_mode, name, resource_group, auto_storage_account, location, key_vault

Create, update and delete instance of Azure Batch Account.

Azure Rm Cdnendpoint *arguments

Manage a Azure CDN endpoint

Arguments: resource_group, started, is_https_allowed, query_string_caching_behavior, profile_name, purge_content_paths, origin_host_header, name, origins, origin_path, purge, state, location, content_types_to_compress, is_http_allowed, is_compression_enabled

Create, update, start, stop and delete a Azure CDN endpoint.

Azure Rm Cdnendpoint Info *arguments

Get Azure CDN endpoint facts

Arguments: profile_name, name, resource_group, tags

Get facts for a specific Azure CDN endpoint or all Azure CDN endpoints.

Azure Rm Cdnprofile *arguments

Manage a Azure CDN profile

Arguments: sku, state, name, resource_group, location

Create, update and delete a Azure CDN profile.

Azure Rm Cdnprofile Info *arguments

Get Azure CDN profile facts

Arguments: name, resource_group, tags

Get facts for a specific Azure CDN profile or all CDN profiles.

Azure Rm Containerinstance *arguments

Manage an Azure Container Instance

Arguments: registry_username, name, resource_group, dns_name_label, force_update, restart_policy, state, registry_password, registry_login_server, location, os_type, ip_address, ports, containers

Create, update and delete an Azure Container Instance.

Azure Rm Containerinstance Info *arguments

Get Azure Container Instance facts

Arguments: name, resource_group, tags

Get facts of Container Instance.

Azure Rm Containerregistry *arguments

Manage an Azure Container Registry

Arguments: sku, state, name, resource_group, admin_user_enabled, location

Create, update and delete an Azure Container Registry.

Azure Rm Containerregistry Info *arguments

Get Azure Container Registry facts

Arguments: retrieve_credentials, name, resource_group, tags

Get facts for Container Registry.

Azure Rm Cosmosdbaccount *arguments

Manage Azure Database Account instance

Arguments: enable_automatic_failover, resource_group, geo_rep_locations, virtual_network_rules, database_account_offer_type, is_virtual_network_filter_enabled, enable_gremlin, enable_multiple_write_locations, enable_table, kind, name, consistency_policy, ip_range_filter, state, location, enable_cassandra

Create, update and delete instance of Azure Database Account.

Azure Rm Cosmosdbaccount Info *arguments

Get Azure Cosmos DB Account facts

Arguments: resource_group, tags, name, retrieve_keys, retrieve_connection_strings

Get facts of Azure Cosmos DB Account.

Azure Rm Deployment *arguments

Create or destroy Azure Resource Manager template deployments

Arguments: wait_for_deployment_completion, resource_group, wait_for_deployment_polling_period, template_link, name, state, location, deployment_mode, parameters_link, parameters, template

Create or destroy Azure Resource Manager template deployments via the Azure SDK for Python. You can find some quick start templates in GitHub here U(https://github.com/azure/azure-quickstart-templates). For more information on Azure Resource Manager templates see U(https://azure.microsoft.com/en-us/documentation/articles/resource-group-template-deploy/).

Azure Rm Deployment Info *arguments

Get Azure Deployment facts

Arguments: name, resource_group

Get facts of Azure Deployment.

Azure Rm Devtestlab *arguments

Manage Azure DevTest Lab instance

Arguments: storage_type, name, resource_group, premium_data_disks, state, location

Create, update and delete instance of Azure DevTest Lab.

Azure Rm Devtestlab Info *arguments

Get Azure DevTest Lab facts

Arguments: name, resource_group, tags

Get facts of Azure DevTest Lab.

Azure Rm Devtestlabarmtemplate Info *arguments

Get Azure DevTest Lab ARM Template facts

Arguments: artifact_source_name, lab_name, name, resource_group

Get facts of Azure DevTest Lab ARM Template.

Azure Rm Devtestlabartifact Info *arguments

Get Azure DevTest Lab Artifact facts

Arguments: artifact_source_name, lab_name, name, resource_group

Get facts of Azure DevTest Lab Artifact.

Azure Rm Devtestlabartifactsource *arguments

Manage Azure DevTest Labs Artifacts Source instance

Arguments: is_enabled, display_name, name, security_token, lab_name, resource_group, uri, source_type, state, branch_ref, arm_template_folder_path, folder_path

Create, update and delete instance of Azure DevTest Labs Artifacts Source.

Azure Rm Devtestlabartifactsource Info *arguments

Get Azure DevTest Lab Artifact Source facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure DevTest Lab Artifact Source.

Azure Rm Devtestlabcustomimage *arguments

Manage Azure DevTest Lab Custom Image instance

Arguments: windows_os_state, name, resource_group, linux_os_state, author, source_vm, lab_name, state, description

Create, update and delete instance of Azure DevTest Lab Custom Image.

Azure Rm Devtestlabcustomimage Info *arguments

Get Azure DevTest Lab Custom Image facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure Azure DevTest Lab Custom Image.

Azure Rm Devtestlabenvironment *arguments

Manage Azure DevTest Lab Environment instance

Arguments: name, resource_group, lab_name, deployment_parameters, state, deployment_template, user_name, location

Create, update and delete instance of Azure DevTest Lab Environment.

Azure Rm Devtestlabenvironment Info *arguments

Get Azure Environment facts

Arguments: lab_name, user_name, name, resource_group, tags

Get facts of Azure Environment.

Azure Rm Devtestlabpolicy *arguments

Manage Azure Policy instance

Arguments: fact_name, name, resource_group, policy_set_name, lab_name, state, threshold, description

Create, update and delete instance of Azure Policy.

Azure Rm Devtestlabpolicy Info *arguments

Get Azure DTL Policy facts

Arguments: policy_set_name, lab_name, name, resource_group, tags

Get facts of Azure DTL Policy.

Azure Rm Devtestlabschedule *arguments

Manage Azure DevTest Lab Schedule instance

Arguments: lab_name, state, name, resource_group, time, time_zone_id

Create, update and delete instance of Azure DecTest Lab Schedule.

Azure Rm Devtestlabschedule Info *arguments

Get Azure Schedule facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure Schedule.

Azure Rm Devtestlabvirtualmachine *arguments

Manage Azure DevTest Lab Virtual Machine instance

Arguments: lab_subnet, resource_group, image, ssh_key, allow_claim, storage_type, disallow_public_ip_address, vm_size, password, name, artifacts, expiration_date, notes, lab_name, state, os_type, user_name

Create, update and delete instance of Azure DevTest Lab Virtual Machine.

Azure Rm Devtestlabvirtualmachine Info *arguments

Get Azure DevTest Lab Virtual Machine facts

Arguments: lab_name, name, resource_group, tags

Get facts of Azure DevTest Lab Virtual Machine.

Azure Rm Devtestlabvirtualnetwork *arguments

Manage Azure DevTest Lab Virtual Network instance

Arguments: lab_name, state, description, resource_group, name, location

Create, update and delete instance of Azure DevTest Lab Virtual Network.

Azure Rm Devtestlabvirtualnetwork Info *arguments

Get Azure DevTest Lab Virtual Network facts

Arguments: lab_name, name, resource_group

Get facts of Azure DevTest Lab Virtual Network.

Azure Rm Dnsrecordset *arguments

Create, delete and update DNS record sets and records

Arguments: resource_group, record_type, record_mode, state, relative_name, records, time_to_live, zone_name

Creates, deletes, and updates DNS records sets and records within an existing Azure DNS Zone.

Azure Rm Dnsrecordset Info *arguments

Get DNS Record Set facts

Arguments: zone_name, top, relative_name, resource_group, record_type

Get facts for a specific DNS Record Set in a Zone, or a specific type in all Zones or in one Zone etc.

Azure Rm Dnszone *arguments

Manage Azure DNS zones

Arguments: registration_virtual_networks, state, name, resource_group, resolution_virtual_networks, type

Creates and deletes Azure DNS zones.

Azure Rm Dnszone Info *arguments

Get DNS zone facts

Arguments: name, resource_group, tags

Get facts for a specific DNS zone or all DNS zones within a resource group.

Azure Rm Functionapp *arguments

Manage Azure Function Apps

Arguments: name, resource_group, state, location, app_settings, storage_account, plan, container_settings

Create, update or delete an Azure Function App.

Azure Rm Functionapp Info *arguments

Get Azure Function App facts

Arguments: name, resource_group, tags

Get facts for one Azure Function App or all Function Apps within a resource group.

Azure Rm Gallery *arguments

Manage Azure Shared Image Gallery instance.

Arguments: state, location, description, resource_group, name

Create, update and delete instance of Azure Shared Image Gallery (SIG).

Azure Rm Gallery Info *arguments

Get Azure Shared Image Gallery info.

Arguments: name, resource_group

Get info of Azure Shared Image Gallery.

Azure Rm Galleryimage *arguments

Manage Azure SIG Image instance.

Arguments: eula, gallery_name, description, resource_group, os_state, privacy_statement_uri, release_note_uri, name, recommended, end_of_life_date, state, location, purchase_plan, os_type, identifier, disallowed

Create, update and delete instance of Azure SIG Image.

Azure Rm Galleryimage Info *arguments

Get Azure SIG Image info.

Arguments: gallery_name, name, resource_group

Get info of Azure SIG Image.

Azure Rm Galleryimageversion *arguments

Manage Azure SIG Image Version instance.

Arguments: gallery_image_name, state, gallery_name, name, resource_group, publishing_profile, location

Create, update and delete instance of Azure SIG Image Version.

Azure Rm Galleryimageversion Info *arguments

Get Azure SIG Image Version info.

Arguments: gallery_image_name, gallery_name, name, resource_group

Get info of Azure SIG Image Version.

Azure Rm Hdinsightcluster *arguments

Manage Azure HDInsight Cluster instance

Arguments: name, storage_accounts, cluster_version, resource_group, tier, state, location, compute_profile_roles, os_type, cluster_definition

Create, update and delete instance of Azure HDInsight Cluster.

Azure Rm Hdinsightcluster Info *arguments

Get Azure HDInsight Cluster facts

Arguments: name, resource_group, tags

Get facts of Azure HDInsight Cluster.

Azure Rm Image *arguments

Manage Azure image

Arguments: source, state, name, resource_group, os_type, data_disk_sources, location

Create, delete an image from virtual machine, blob uri, managed disk or snapshot.

Azure Rm Image Info *arguments

Get facts about azure custom images

Arguments: name, resource_group, tags

List azure custom images. The images can be listed where scope of listing can be based on subscription, resource group, name or tags.

Azure Rm Iotdevice *arguments

Manage Azure IoT hub device

Arguments: status, name, hub, secondary_key, twin_tags, desired, state, edge_enabled, hub_policy_name, hub_policy_key, auth_method, primary_key

Create, delete an Azure IoT hub device.

Azure Rm Iotdevice Info *arguments

Facts of Azure IoT hub device

Arguments: name, hub, module_id, query, top, hub_policy_name, hub_policy_key

Query, get Azure IoT hub device.

Azure Rm Iotdevicemodule *arguments

Manage Azure IoT hub device module

Arguments: name, hub, secondary_key, twin_tags, desired, state, device, hub_policy_name, hub_policy_key, auth_method, primary_key

Create, delete an Azure IoT hub device module.

Azure Rm Iothub *arguments

Manage Azure IoT hub

Arguments: sku, name, resource_group, event_endpoint, routing_endpoints, enable_file_upload_notifications, state, location, routes, ip_filters, unit

Create, delete an Azure IoT hub.

Azure Rm Iothub Info *arguments

Get IoT Hub facts

Arguments: show_stats, name, resource_group, tags, show_quota_metrics, test_route_message, list_consumer_groups, list_keys, show_endpoint_health

Get facts for a specific IoT Hub or all IoT Hubs.

Azure Rm Iothubconsumergroup *arguments

Manage Azure IoT hub

Arguments: event_hub, state, name, hub, resource_group

Create, delete an Azure IoT hub.

Azure Rm Keyvault *arguments

Manage Key Vault instance

Arguments: sku, resource_group, recover_mode, enabled_for_disk_encryption, enabled_for_template_deployment, state, vault_name, enabled_for_deployment, access_policies, vault_tenant, enable_soft_delete, location

Create, update and delete instance of Key Vault.

Azure Rm Keyvault Info *arguments

Get Azure Key Vault facts

Arguments: name, resource_group, tags

Get facts of Azure Key Vault.

Azure Rm Keyvaultkey *arguments

Use Azure KeyVault keys

Arguments: keyvault_uri, pem_password, byok_file, key_name, state, pem_file

Create or delete a key within a given keyvault. By using Key Vault, you can encrypt keys and secrets. Such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords.

Azure Rm Keyvaultkey Info *arguments

Get Azure Key Vault key facts.

Arguments: show_deleted_key, vault_uri, version, name, tags

Get facts of Azure Key Vault key.

Azure Rm Keyvaultsecret *arguments

Use Azure KeyVault Secrets

Arguments: keyvault_uri, state, secret_name, secret_value

Create or delete a secret within a given keyvault. By using Key Vault, you can encrypt keys and secrets. Such as authentication keys, storage account keys, data encryption keys, .PFX files, and passwords.

Azure Rm Loadbalancer *arguments

Manage Azure load balancers

Arguments: public_ip_address_name, probe_port, load_balancing_rules, resource_group, natpool_protocol, inbound_nat_pools, idle_timeout, probe_interval, probe_protocol, load_distribution, frontend_port, natpool_frontend_port_start, backend_port, probes, sku, probe_fail_count, natpool_frontend_port_end, natpool_backend_port, name, backend_address_pools, inbound_nat_rules, protocol, frontend_ip_configurations, state, location, probe_request_path

Create, update and delete Azure load balancers.

Azure Rm Loadbalancer Info *arguments

Get load balancer facts

Arguments: name, resource_group, tags

Get facts for a specific load balancer or all load balancers.

Azure Rm Lock *arguments

Manage Azure locks

Arguments: managed_resource_id, state, name, resource_group, level

Create, delete an Azure lock. To create or delete management locks, you must have access to Microsoft.Authorization/* or Microsoft.Authorization/locks/* actions. Of the built-in roles, only Owner and User Access Administrator are granted those actions.

Azure Rm Lock Info *arguments

Manage Azure locks

Arguments: name, resource_group, managed_resource_id

Create, delete an Azure lock.

Azure Rm Loganalyticsworkspace *arguments

Manage Azure Log Analytics workspaces

Arguments: sku, intelligence_packs, state, retention_in_days, name, resource_group, location

Create, delete Azure Log Analytics workspaces.

Azure Rm Loganalyticsworkspace Info *arguments

Get facts of Azure Log Analytics workspaces

Arguments: show_management_groups, show_shared_keys, name, resource_group, tags, show_intelligence_packs, show_usages

Get, query Azure Log Analytics workspaces.

Azure Rm Manageddisk *arguments

Manage Azure Manage Disks

Arguments: attach_caching, disk_size_gb, name, resource_group, tags, source_uri, storage_account_type, state, managed_by, location, os_type, zone, create_option

Create, update and delete an Azure Managed Disk.

Azure Rm Manageddisk Info *arguments

Get managed disk facts

Arguments: name, resource_group, tags

Get facts for a specific managed disk or all managed disks.

Azure Rm Mariadbconfiguration *arguments

Manage Configuration instance

Arguments: name, state, server_name, value, resource_group

Create, update and delete instance of Configuration.

Azure Rm Mariadbconfiguration Info *arguments

Get Azure MariaDB Configuration facts

Arguments: resource_group, server_name, name

Get facts of Azure MariaDB Configuration.

Azure Rm Mariadbdatabase *arguments

Manage MariaDB Database instance

Arguments: state, charset, server_name, resource_group, collation, force_update, name

Create, update and delete instance of MariaDB Database.

Azure Rm Mariadbdatabase Info *arguments

Get Azure MariaDB Database facts

Arguments: resource_group, server_name, name

Get facts of MariaDB Database.

Azure Rm Mariadbfirewallrule *arguments

Manage MariaDB firewall rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of MariaDB firewall rule.

Azure Rm Mariadbfirewallrule Info *arguments

Get Azure MariaDB Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of Azure MariaDB Firewall Rule.

Azure Rm Mariadbserver *arguments

Manage MariaDB Server instance

Arguments: sku, name, resource_group, storage_mb, admin_username, create_mode, state, version, location, enforce_ssl, admin_password

Create, update and delete instance of MariaDB Server.

Azure Rm Mariadbserver Info *arguments

Get Azure MariaDB Server facts

Arguments: name, resource_group, tags

Get facts of MariaDB Server.

Azure Rm Monitorlogprofile *arguments

Manage Azure Monitor log profile

Arguments: retention_policy, name, locations, state, location, service_bus_rule_id, storage_account, categories

Create, update and delete instance of Azure Monitor log profile.

Azure Rm Mysqlconfiguration *arguments

Manage Configuration instance

Arguments: name, state, server_name, value, resource_group

Create, update and delete instance of Configuration.

Azure Rm Mysqlconfiguration Info *arguments

Get Azure MySQL Configuration facts

Arguments: resource_group, server_name, name

Get facts of Azure MySQL Configuration.

Azure Rm Mysqldatabase *arguments

Manage MySQL Database instance

Arguments: state, charset, server_name, resource_group, collation, force_update, name

Create, update and delete instance of MySQL Database.

Azure Rm Mysqldatabase Info *arguments

Get Azure MySQL Database facts

Arguments: resource_group, server_name, name

Get facts of MySQL Database.

Azure Rm Mysqlfirewallrule *arguments

Manage MySQL firewall rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of MySQL firewall rule.

Azure Rm Mysqlfirewallrule Info *arguments

Get Azure MySQL Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of Azure MySQL Firewall Rule.

Azure Rm Mysqlserver *arguments

Manage MySQL Server instance

Arguments: sku, name, resource_group, storage_mb, admin_username, create_mode, state, version, location, enforce_ssl, admin_password

Create, update and delete instance of MySQL Server.

Azure Rm Mysqlserver Info *arguments

Get Azure MySQL Server facts

Arguments: name, resource_group, tags

Get facts of MySQL Server.

Azure Rm Networkinterface *arguments

Manage Azure network interfaces

Arguments: dns_servers, private_ip_address, resource_group, public_ip_allocation_method, open_ports, public_ip, private_ip_allocation_method, enable_accelerated_networking, ip_configurations, public_ip_address_name, name, enable_ip_forwarding, state, subnet_name, location, create_with_security_group, security_group, virtual_network, os_type

Create, update or delete a network interface. When creating a network interface you must provide the name of an existing virtual network, the name of an existing subnet within the virtual network. A default security group and public IP address will be created automatically. Or you can provide the name of an existing security group and public IP address. See the examples below for more details.

Azure Rm Networkinterface Info *arguments

Get network interface facts

Arguments: name, resource_group, tags

Get facts for a specific network interface or all network interfaces within a resource group.

Azure Rm Postgresqlconfiguration *arguments

Manage Azure PostgreSQL Configuration

Arguments: name, state, server_name, value, resource_group

Update or reset Azure PostgreSQL Configuration setting.

Azure Rm Postgresqlconfiguration Info *arguments

Get Azure PostgreSQL Configuration facts

Arguments: resource_group, server_name, name

Get facts of Azure PostgreSQL Configuration.

Azure Rm Postgresqldatabase *arguments

Manage PostgreSQL Database instance

Arguments: state, charset, server_name, resource_group, collation, force_update, name

Create, update and delete instance of PostgreSQL Database.

Azure Rm Postgresqldatabase Info *arguments

Get Azure PostgreSQL Database facts

Arguments: resource_group, server_name, name

Get facts of PostgreSQL Database.

Azure Rm Postgresqlfirewallrule *arguments

Manage PostgreSQL firewall rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of PostgreSQL firewall rule.

Azure Rm Postgresqlfirewallrule Info *arguments

Get Azure PostgreSQL Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of Azure PostgreSQL Firewall Rule.

Azure Rm Postgresqlserver *arguments

Manage PostgreSQL Server instance

Arguments: sku, name, resource_group, storage_mb, admin_username, create_mode, state, version, location, enforce_ssl, admin_password

Create, update and delete instance of PostgreSQL Server.

Azure Rm Postgresqlserver Info *arguments

Get Azure PostgreSQL Server facts

Arguments: name, resource_group, tags

Get facts of PostgreSQL Server.

Azure Rm Publicipaddress *arguments

Manage Azure Public IP Addresses

Arguments: sku, name, resource_group, state, domain_name, idle_timeout, version, location, allocation_method, ip_tags

Create, update and delete a Public IP address. Allows setting and updating the address allocation method and domain name label. Use the M(azure_rm_networkinterface) module to associate a Public IP with a network interface.

Azure Rm Publicipaddress Info *arguments

Get public IP facts

Arguments: name, resource_group, tags

Get facts for a specific public IP or all public IPs within a resource group.

Azure Rm Rediscache *arguments

Manage Azure Cache for Redis instance

Arguments: maxfragmentationmemory_reserved, resource_group, shard_count, maxmemory_policy, static_ip, regenerate_key, notify_keyspace_events, sku, subnet, enable_non_ssl_port, name, maxmemory_reserved, wait_for_provisioning, reboot, state, location, tenant_settings

Create, update and delete instance of Azure Cache for Redis.

Azure Rm Rediscache Info *arguments

Get Azure Cache for Redis instance facts

Arguments: return_access_keys, name, resource_group, tags

Get facts for Azure Cache for Redis instance.

Azure Rm Rediscachefirewallrule *arguments

Manage Azure Cache for Redis Firewall rules

Arguments: state, end_ip_address, name, resource_group, start_ip_address, cache_name

Create, update and delete Azure Cache for Redis Firewall rules.

Azure Rm Resource *arguments

Create any Azure resource

Arguments: body, resource_name, subresource, resource_group, url, status_code, provider, idempotency, state, resource_type, polling_interval, polling_timeout, method, api_version

Create, update or delete any Azure resource using Azure REST API. This module gives access to resources that are not supported via Ansible modules. Refer to U(https://docs.microsoft.com/en-us/rest/api/) regarding details related to specific resource REST API.

Azure Rm Resource Info *arguments

Generic facts of Azure resources

Arguments: resource_type, resource_name, subresource, resource_group, provider, url, api_version

Obtain facts of any resource using Azure REST API. This module gives access to resources that are not supported via Ansible modules. Refer to U(https://docs.microsoft.com/en-us/rest/api/) regarding details related to specific resource REST API.

Azure Rm Resourcegroup *arguments

Manage Azure resource groups

Arguments: state, location, force_delete_nonempty, name

Create, update and delete a resource group.

Azure Rm Resourcegroup Info *arguments

Get resource group facts

Arguments: list_resources, name, tags

Get facts for a specific resource group or all resource groups.

Azure Rm Roleassignment *arguments

Manage Azure Role Assignment

Arguments: assignee_object_id, role_definition_id, scope, state, name

Create and delete instance of Azure Role Assignment.

Azure Rm Roleassignment Info *arguments

Gets Azure Role Assignment facts

Arguments: scope, role_definition_id, name, assignee

Gets facts of Azure Role Assignment.

Azure Rm Roledefinition *arguments

Manage Azure Role Definition

Arguments: state, description, name, scope, assignable_scopes, permissions

Create, update and delete instance of Azure Role Definition.

Azure Rm Roledefinition Info *arguments

Get Azure Role Definition facts

Arguments: scope, role_name, type, id

Get facts of Azure Role Definition.

Azure Rm Route *arguments

Manage Azure route resource

Arguments: state, next_hop_type, route_table_name, name, resource_group, next_hop_ip_address, address_prefix

Create, update or delete a route.

Azure Rm Routetable *arguments

Manage Azure route table resource

Arguments: state, location, name, disable_bgp_route_propagation, resource_group

Create, update or delete a route table.

Azure Rm Routetable Info *arguments

Get route table facts

Arguments: name, resource_group, tags

Get facts for a specific route table or all route table in a resource group or subscription.

Azure Rm Securitygroup *arguments

Manage Azure network security groups

Arguments: resource_group, purge_rules, rules, default_rules, purge_default_rules, state, location, name

Create, update or delete a network security group. A security group contains Access Control List (ACL) rules that allow or deny network traffic to subnets or individual network interfaces. A security group is created with a set of default security rules and an empty set of security rules. Shape traffic flow by adding rules to the empty set of security rules.

Azure Rm Securitygroup Info *arguments

Get security group facts

Arguments: name, resource_group, tags

Get facts for a specific security group or all security groups within a resource group.

Azure Rm Servicebus *arguments

Manage Azure Service Bus

Arguments: sku, state, name, resource_group, location

Create, update or delete an Azure Service Bus namespaces.

Azure Rm Servicebus Info *arguments

Get servicebus facts

Arguments: topic, name, resource_group, tags, type, namespace, show_sas_policies

Get facts for a specific servicebus or all servicebus in a resource group or subscription.

Azure Rm Servicebusqueue *arguments

Manage Azure Service Bus queue

Arguments: status, max_size_in_mb, default_message_time_to_live_seconds, duplicate_detection_time_in_seconds, resource_group, enable_batched_operations, auto_delete_on_idle_in_seconds, enable_express, max_delivery_count, lock_duration_in_seconds, name, requires_duplicate_detection, requires_session, namespace, enable_partitioning, dead_lettering_on_message_expiration, forward_dead_lettered_messages_to, state, forward_to

Create, update or delete an Azure Service Bus queue.

Azure Rm Servicebussaspolicy *arguments

Manage Azure Service Bus SAS policy

Arguments: queue, name, resource_group, rights, namespace, regenerate_secondary_key, regenerate_primary_key, topic, state

Create, update or delete an Azure Service Bus SAS policy.

Azure Rm Servicebustopic *arguments

Manage Azure Service Bus

Arguments: max_size_in_mb, status, default_message_time_to_live_seconds, duplicate_detection_time_in_seconds, name, resource_group, namespace, enable_batched_operations, auto_delete_on_idle_in_seconds, enable_partitioning, state, enable_express, support_ordering, requires_duplicate_detection

Create, update or delete an Azure Service Bus topics.

Azure Rm Servicebustopicsubscription *arguments

Manage Azure Service Bus subscription

Arguments: status, default_message_time_to_live_seconds, duplicate_detection_time_in_seconds, resource_group, enable_batched_operations, auto_delete_on_idle_in_seconds, topic, max_delivery_count, dead_lettering_on_filter_evaluation_exceptions, lock_duration_in_seconds, name, requires_session, namespace, dead_lettering_on_message_expiration, forward_dead_lettered_messages_to, state, forward_to

Create, update or delete an Azure Service Bus subscriptions.

Azure Rm Snapshot *arguments

Manage Azure Snapshot instance.

Arguments: sku, state, name, resource_group, os_type, creation_data, location

Create, update and delete instance of Azure Snapshot.

Azure Rm Sqldatabase *arguments

Manage SQL Database instance

Arguments: resource_group, recovery_services_recovery_point_resource_id, edition, elastic_pool_name, max_size_bytes, zone_redundant, name, restore_point_in_time, server_name, create_mode, source_database_deletion_date, force_update, collation, source_database_id, state, location, sample_name, read_scale

Create, update and delete instance of SQL Database.

Azure Rm Sqldatabase Info *arguments

Get Azure SQL Database facts

Arguments: name, resource_group, elastic_pool_name, server_name, tags

Get facts of Azure SQL Database.

Azure Rm Sqlfirewallrule *arguments

Manage Firewall Rule instance

Arguments: state, server_name, resource_group, start_ip_address, end_ip_address, name

Create, update and delete instance of Firewall Rule.

Azure Rm Sqlfirewallrule Info *arguments

Get Azure SQL Firewall Rule facts

Arguments: resource_group, server_name, name

Get facts of SQL Firewall Rule.

Azure Rm Sqlserver *arguments

Manage SQL Server instance

Arguments: name, resource_group, admin_username, state, version, admin_password, identity, location

Create, update and delete instance of SQL Server.

Azure Rm Sqlserver Info *arguments

Get SQL Server facts

Arguments: resource_group, server_name

Get facts of SQL Server.

Azure Rm Storageaccount *arguments

Manage Azure storage accounts

Arguments: kind, account_type, custom_domain, resource_group, blob_cors, name, state, location, access_tier, https_only, force_delete_nonempty

Create, update or delete a storage account.

Azure Rm Storageaccount Info *arguments

Get storage account facts

Arguments: tags, show_connection_string, name, resource_group, show_blob_cors

Get facts for one storage account or all storage accounts within a resource group.

Azure Rm Storageblob *arguments

Manage blob containers and blob objects

Arguments: force, resource_group, dest, content_language, content_type, public_access, src, container, blob_type, state, blob, content_md5, storage_account_name, content_disposition, cache_control, content_encoding

Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object, or download a blob object to a file.

Azure Rm Subnet *arguments

Manage Azure subnets

Arguments: name, resource_group, virtual_network_name, address_prefix_cidr, state, route_table, service_endpoints, security_group

Create, update or delete a subnet within a given virtual network. Allows setting and updating the address prefix CIDR, which must be valid within the context of the virtual network. Use the M(azure_rm_networkinterface) module to associate interfaces with the subnet and assign specific IP addresses.

Azure Rm Subnet Info *arguments

Get Azure Subnet facts

Arguments: virtual_network_name, name, resource_group

Get facts of Azure Subnet.

Azure Rm Trafficmanagerendpoint *arguments

Manage Azure Traffic Manager endpoint

Arguments: target_resource_id, name, resource_group, min_child_endpoints, enabled, weight, priority, state, profile_name, geo_mapping, location, type, target

Create, update and delete Azure Traffic Manager endpoint.

Azure Rm Trafficmanagerendpoint Info *arguments

Get Azure Traffic Manager endpoint facts

Arguments: profile_name, type, name, resource_group

Get facts for a specific Traffic Manager endpoints or all endpoints in a Traffic Manager profile.

Azure Rm Trafficmanagerprofile *arguments

Manage Azure Traffic Manager profile

Arguments: routing_method, name, resource_group, dns_config, state, location, monitor_config, profile_status

Create, update and delete a Traffic Manager profile.

Azure Rm Trafficmanagerprofile Info *arguments

Get Azure Traffic Manager profile facts

Arguments: name, resource_group, tags

Get facts for a Azure specific Traffic Manager profile or all Traffic Manager profiles.

Azure Rm Virtualmachine *arguments

Manage Azure virtual machines

Arguments: virtual_network_resource_group, resource_group, public_ip_allocation_method, image, zones, managed_disk_type, ssh_public_keys, os_disk_name, storage_container_name, allocated, ssh_password_enabled, storage_blob_name, remove_on_absent, availability_set, winrm, short_hostname, started, state, subnet_name, admin_password, network_interface_names, generalized, location, virtual_network_name, custom_data, open_ports, plan, accept_terms, vm_size, os_disk_size_gb, name, restarted, boot_diagnostics, admin_username, vm_identity, license_type, os_type, storage_account_name, data_disks, os_disk_caching

Manage and configure virtual machines (VMs) and associated resources on Azure. Requires a resource group containing at least one virtual network with at least one subnet. Supports images from the Azure Marketplace, which can be discovered with M(azure_rm_virtualmachineimage_facts). Supports custom images since Ansible 2.5. To use I(custom_data) on a Linux image, the image must have cloud-init enabled. If cloud-init is not enabled, I(custom_data) is ignored.

Azure Rm Virtualmachine Info *arguments

Get virtual machine facts

Arguments: name, resource_group, tags

Get facts for one or all virtual machines in a resource group.

Azure Rm Virtualmachineextension *arguments

Managed Azure Virtual Machine extension

Arguments: publisher, virtual_machine_extension_type, name, resource_group, settings, state, location, protected_settings, type_handler_version, auto_upgrade_minor_version, virtual_machine_name

Create, update and delete Azure Virtual Machine Extension. Note that this module was called M(azure_rm_virtualmachine_extension) before Ansible 2.8. The usage did not change.

Azure Rm Virtualmachineextension Info *arguments

Get Azure Virtual Machine Extension facts

Arguments: virtual_machine_name, name, resource_group, tags

Get facts of Azure Virtual Machine Extension.

Azure Rm Virtualmachineimage Info *arguments

Get virtual machine image facts

Arguments: sku, publisher, version, location, offer

Get facts for virtual machine images.

Azure Rm Virtualmachinescaleset *arguments

Manage Azure virtual machine scale sets

Arguments: load_balancer, application_gateway, virtual_network_resource_group, resource_group, virtual_network_name, image, upgrade_policy, zones, managed_disk_type, ssh_public_keys, enable_accelerated_networking, tier, vm_size, ssh_password_enabled, remove_on_absent, capacity, name, overprovision, admin_username, short_hostname, state, subnet_name, location, single_placement_group, custom_data, security_group, os_type, os_disk_caching, data_disks, admin_password

Create and update a virtual machine scale set. Note that this module was called M(azure_rm_virtualmachine_scaleset) before Ansible 2.8. The usage did not change.

Azure Rm Virtualmachinescaleset Info *arguments

Get Virtual Machine Scale Set facts

Arguments: tags, name, resource_group, format

Get facts for a virtual machine scale set. Note that this module was called M(azure_rm_virtualmachine_scaleset_facts) before Ansible 2.8. The usage did not change.

Azure Rm Virtualmachinescalesetextension *arguments

Manage Azure Virtual Machine Scale Set (VMSS) extensions

Arguments: publisher, vmss_name, name, resource_group, settings, type, state, location, protected_settings, type_handler_version, auto_upgrade_minor_version

Create, update and delete Azure Virtual Machine Scale Set (VMSS) extensions.

Azure Rm Virtualmachinescalesetextension Info *arguments

Get Azure Virtual Machine Scale Set Extension facts

Arguments: vmss_name, name, resource_group

Get facts of Azure Virtual Machine Scale Set Extension.

Azure Rm Virtualmachinescalesetinstance *arguments

Get Azure Virtual Machine Scale Set Instance facts

Arguments: instance_id, state, vmss_name, power_state, resource_group, latest_model

Get facts of Azure Virtual Machine Scale Set VMs.

Azure Rm Virtualmachinescalesetinstance Info *arguments

Get Azure Virtual Machine Scale Set Instance facts

Arguments: instance_id, vmss_name, resource_group, tags

Get facts of Azure Virtual Machine Scale Set VMs.

Azure Rm Virtualnetwork *arguments

Manage Azure virtual networks

Arguments: dns_servers, name, resource_group, state, address_prefixes_cidr, purge_address_prefixes, purge_dns_servers, location

Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the M(azure_rm_subnet) module to associate subnets with a virtual network.

Azure Rm Virtualnetwork Info *arguments

Get virtual network facts

Arguments: name, resource_group, tags

Get facts for a specific virtual network or all virtual networks within a resource group.

Azure Rm Virtualnetworkgateway *arguments

Manage Azure virtual network gateways

Arguments: sku, name, resource_group, vpn_type, enable_bgp, bgp_settings, state, location, virtual_network, ip_configurations, gateway_type

Create, update or delete a virtual network gateway(VPN Gateway). When creating a VPN Gateway you must provide the name of an existing virtual network.

Azure Rm Virtualnetworkpeering *arguments

Manage Azure Virtual Network Peering

Arguments: name, resource_group, remote_virtual_network, state, allow_forwarded_traffic, virtual_network, use_remote_gateways, allow_virtual_network_access, allow_gateway_transit

Create, update and delete Azure Virtual Network Peering.

Azure Rm Virtualnetworkpeering Info *arguments

Get facts of Azure Virtual Network Peering

Arguments: virtual_network, name, resource_group

Get facts of Azure Virtual Network Peering.

Azure Rm Webapp *arguments

Manage Web App instances

Arguments: resource_group, dns_registration, scm_type, app_settings, plan, https_only, deployment_source, app_state, name, purge_app_settings, skip_custom_domain_verification, frameworks, state, location, client_affinity_enabled, startup_file, ttl_in_seconds, container_settings

Create, update and delete instance of Web App.

Azure Rm Webapp Info *arguments

Get Azure web app facts

Arguments: resource_group, name, return_publish_profile, tags

Get facts for a specific web app or all web app in a resource group, or all web app in current subscription.

Azure Rm Webappslot *arguments

Manage Azure Web App slot

Arguments: configuration_source, name, resource_group, purge_app_settings, app_state, frameworks, state, container_settings, app_settings, startup_file, auto_swap_slot_name, webapp_name, swap, deployment_source, location

Create, update and delete Azure Web App slot.

Bcf Switch *arguments

Create and remove a bcf switch.

Arguments: name, access_token, state, mac, controller, leaf_group, validate_certs, fabric_role

Create and remove a Big Cloud Fabric switch.

Beadm *arguments

Manage ZFS boot environments on FreeBSD/Solaris/illumos systems.

Arguments: state, force, name, mountpoint, snapshot, options, description

Create, delete or activate ZFS boot environments. Mount and unmount ZFS boot environments.

Bearychat *arguments

Send BearyChat notifications

Arguments: url, text, markdown, attachments, channel

The M(bearychat) module sends notifications to U(https://bearychat.com) via the Incoming Robot integration.

Bigip Apm Acl *arguments

Manage user-defined APM ACLs

Arguments: path_match_case, acl_order, partition, name, state, entries, type, description

Manage user-defined APM ACLs.

Bigip Apm Network Access *arguments

Manage APM Network Access resource

Arguments: dtls_port, allow_local_subnet, excluded_ipv6_adresses, ipv6_address_space, ip_version, excluded_ipv4_adresses, allow_local_dns, ipv4_address_space, dtls, split_tunnel, ipv4_lease_pool, name, description, partition, dns_address_space, state, ipv6_lease_pool, snat_pool, excluded_dns_addresses

Manage APM Network Access resource.

Bigip Apm Policy Fetch *arguments

Exports the APM policy or APM access profile from remote nodes.

Arguments: force, name, file, dest, partition, type

Exports the apm policy or APM access profile from remote nodes.

Bigip Apm Policy Import *arguments

Manage BIG-IP APM policy or APM access profile imports

Arguments: source, partition, force, name, type

Manage BIG-IP APM policy or APM access profile imports.

Bigip Appsvcs Extension *arguments

Manage application service deployments

Arguments: content, tenants, state, force

Manages application service deployments via the App Services Extension functionality in BIG-IP.

Bigip Asm Dos Application *arguments

Manage application settings for DOS profile

Arguments: profile, geolocations, trigger_irule, heavy_urls, mobile_detection, partition, rtbh_enable, rtbh_duration, scrubbing_enable, state, scrubbing_duration, single_page_application

Manages Application settings for ASM/AFM DOS profile.

Bigip Asm Policy Fetch *arguments

Exports the asm policy from remote nodes.

Arguments: compact, binary, base64, force, name, dest, partition, file, inline

Exports the asm policy from remote nodes.

Bigip Asm Policy Import *arguments

Manage BIG-IP ASM policy imports

Arguments: inline, partition, force, name, source

Manage BIG-IP ASM policies policy imports.

Bigip Asm Policy Manage *arguments

Manage BIG-IP ASM policies

Arguments: active, state, partition, name, template

Manage BIG-IP ASM policies, create from templates and manage global policy settings.

Bigip Asm Policy Server Technology *arguments

Manages Server Technology on ASM policy

Arguments: state, partition, name, policy_name

Manages Server Technology on ASM policy.

Bigip Asm Policy Signature Set *arguments

Manages Signature Sets on ASM policy

Arguments: state, name, learn, alarm, partition, block, policy_name

Manages Signature Sets on ASM policy.

Bigip Cli Alias *arguments

Manage CLI aliases on a BIG-IP

Arguments: state, command, name, scope, partition, description

Allows for managing both private and shared aliases on a BIG-IP.

Bigip Cli Script *arguments

Manage CLI scripts on a BIG-IP

Arguments: content, state, partition, name, description

Manages CLI scripts on a BIG-IP. CLI scripts, otherwise known as tmshell scripts or TMSH scripts allow you to create custom scripts that can run to manage objects within a BIG-IP.

Bigip Command *arguments

Run TMSH and BASH commands on F5 devices

Arguments: retries, commands, chdir, interval, warn, transport, wait_for, match

Sends a TMSH or BASH command to an BIG-IP node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module is B(not) idempotent, nor will it ever be. It is intended as a stop-gap measure to satisfy automation requirements until such a time as a real module has been developed to configure in the way you need. If you are using this module, you should probably also be filing an issue to have a B(real) module created for your needs.

Bigip Config *arguments

Manage BIG-IP configuration sections

Arguments: reset, verify, save, merge_content

Manages a BIG-IP configuration by allowing TMSH commands that modify running configuration, or merge SCF formatted files into the running configuration. Additionally, this module is of significant importance because it allows you to save your running configuration to disk. Since the F5 module only manipulate running configuration, it is important that you utilize this module to save that running config.

Bigip Configsync Action *arguments

Perform different actions related to config-sync

Arguments: overwrite_config, sync_device_to_group, device_group, sync_most_recent_to_device

Allows one to run different config-sync actions. These actions allow you to manually sync your configuration across multiple BIG-IPs when those devices are in an HA pair.

Bigip Data Group *arguments

Manage data groups on a BIG-IP

Arguments: name, delete_data_group_file, partition, records_src, records, state, internal, separator, external_file_name, type, description

Allows for managing data groups on a BIG-IP. Data groups provide a way to store collections of values on a BIG-IP for later use in things such as LTM rules, iRules, and ASM policies.

Bigip Device Auth *arguments

Manage system authentication on a BIG-IP

Arguments: protocol_name, service_name, secret, state, authentication, use_for_auth, update_secret, servers, type

Manage the system authentication configuration. This module can assist in configuring a number of different system authentication types. Note that this module can not be used to configure APM authentication types.

Bigip Device Auth Ldap *arguments

Manage LDAP device authentication settings on BIG-IP

Arguments: update_password, remote_directory_tree, login_ldap_attr, servers, ssl, port, client_key, ca_cert, user_template, check_member_attr, bind_dn, fallback_to_local, state, bind_password, scope, validate_certs, client_cert

Manage LDAP device authentication settings on BIG-IP.

Bigip Device Certificate *arguments

Manage self-signed device certificates

Arguments: force, key_name, days_valid, key_size, cert_name, add_to_trusted, new_cert, transport, issuer

Module used to create and/or renew self-signed device certificates for BIG-IP.

Bigip Device Connectivity *arguments

Manages device IP configuration settings for HA on a BIG-IP

Arguments: multicast_interface, mirror_primary_address, failover_multicast, config_sync_ip, mirror_secondary_address, multicast_address, unicast_failover, cluster_mirroring, multicast_port

Manages device IP configuration settings for HA on a BIG-IP. Each BIG-IP device has synchronization and failover connectivity information (IP addresses) that you define as part of HA pairing or clustering. This module allows you to configure that information.

Bigip Device Dns *arguments

Manage BIG-IP device DNS settings

Arguments: name_servers, ip_version, search, cache, state

Manage BIG-IP device DNS settings.

Bigip Device Group *arguments

Manage device groups on a BIG-IP

Arguments: name, auto_sync, description, max_incremental_sync_size, save_on_auto_sync, state, full_sync, type, network_failover

Managing device groups allows you to create HA pairs and clusters of BIG-IP devices. Usage of this module should be done in conjunction with the C(bigip_configsync_actions) to sync configuration across the pair or cluster if auto-sync is disabled.

Bigip Device Group Member *arguments

Manages members in a device group

Arguments: state, name, device_group

Manages members in a device group. Members in a device group can only be added or removed, never updated. This is because the members are identified by unique name values and changing that name would invalidate the uniqueness.

Bigip Device Ha Group *arguments

Manage HA group settings on a BIG-IP system

Arguments: state, enable, trunks, name, pools, active_bonus, description

Manage HA group settings on a BIG-IP system.

Bigip Device Httpd *arguments

Manage HTTPD related settings on BIG-IP

Arguments: auth_pam_validate_ip, hostname_lookup, log_level, redirect_http_to_https, auth_pam_dashboard_timeout, ssl_protocols, fast_cgi_timeout, allow, ssl_port, auth_pam_idle_timeout, max_clients, ssl_cipher_suite, auth_name

Manages HTTPD related settings on the BIG-IP. These settings are interesting to change when you want to set GUI timeouts and other TMUI related settings.

Bigip Device Info *arguments

Collect information from F5 BIG-IP devices

Arguments: gather_subset

Collect information from F5 BIG-IP devices. This module was called C(bigip_device_facts) before Ansible 2.9. The usage did not change.

Bigip Device License *arguments

Manage license installation and activation on BIG-IP devices

Arguments: license_key, license_server, accept_eula, state

Manage license installation and activation on a BIG-IP.

Bigip Device Ntp *arguments

Manage NTP servers on a BIG-IP

Arguments: ntp_servers, timezone, state

Manage NTP servers on a BIG-IP.

Bigip Device Sshd *arguments

Manage the SSHD settings of a BIG-IP

Arguments: log_level, allow, banner_text, inactivity_timeout, login, banner, port

Manage the SSHD settings of a BIG-IP.

Bigip Device Syslog *arguments

Manage system-level syslog settings on BIG-IP

Arguments: local6_from, mail_from, mail_to, local6_to, auth_priv_from, user_log_from, kern_from, messages_to, kern_to, daemon_from, daemon_to, auth_priv_to, console_log, messages_from, cron_from, iso_date, user_log_to, include, cron_to

Manage system-level syslog settings on BIG-IP.

Bigip Device Traffic Group *arguments

Manages traffic groups on BIG-IP

Arguments: ha_order, name, auto_failback_time, partition, ha_group, auto_failback, state, ha_load_factor, mac_address

Supports managing traffic groups and their attributes on a BIG-IP.

Bigip Device Trust *arguments

Manage the trust relationships between BIG-IPs

Arguments: state, peer_user, peer_server, peer_password, type, peer_hostname

Manage the trust relationships between BIG-IPs. Devices, once peered, cannot be updated. If updating is needed, the peer must first be removed before it can be re-added to the trust.

Bigip Dns Cache Resolver *arguments

Manage DNS resolver cache configurations on BIG-IP

Arguments: answer_default_zones, state, name, forward_zones, partition, route_domain

Manage DNS resolver cache configurations on BIG-IP.

Bigip Dns Nameserver *arguments

Manage LTM DNS nameservers on a BIG-IP

Arguments: route_domain, tsig_key, name, address, service_port, partition, state

Manages LTM DNS nameservers on a BIG-IP. These nameservers form part of what is known as DNS Express on a BIG-IP. This module does not configure GTM related functionality, nor does it configure system-level name servers that affect the base system's ability to resolve DNS names.

Bigip Dns Resolver *arguments

Manage DNS resolvers on a BIG-IP

Arguments: use_udp, randomize_query_case, name, partition, route_domain, answer_default_zones, state, use_ipv4, use_ipv6, cache_size, use_tcp

Manage DNS resolver on a BIG-IP.

Bigip Dns Zone *arguments

Manage DNS zones on BIG-IP

Arguments: tsig_server_key, state, name, dns_express, nameservers, partition

Manage DNS zones on BIG-IP. The zones managed here are primarily used for configuring DNS Express on BIG-IP. This module does not configure zones that are found in BIG-IP ZoneRunner.

Bigip File Copy *arguments

Manage files in datastores on a BIG-IP

Arguments: source, state, force, name, datastore, partition

Manages files on a variety of datastores on a BIG-IP.

Bigip Firewall Address List *arguments

Manage address lists on BIG-IP AFM

Arguments: geo_locations, addresses, name, address_ranges, address_lists, fqdns, partition, state, description

Manages the AFM address lists on a BIG-IP. This module can be used to add and remove address list entries.

Bigip Firewall Dos Profile *arguments

Manage AFM DoS profiles on a BIG-IP

Arguments: default_whitelist, state, name, threshold_sensitivity, partition, description

Manages AFM Denial of Service (DoS) profiles on a BIG-IP. To manage the vectors associated with a DoS profile, refer to the C(bigip_firewall_dos_vector) module.

Bigip Firewall Dos Vector *arguments

Manage attack vector configuration in an AFM DoS profile

Arguments: profile, bad_actor_detection, blacklist_detection_seconds, per_source_ip_mitigation_threshold, threshold_mode, mitigation_threshold_eps, attack_floor, simulate_auto_threshold, name, attack_ceiling, partition, per_source_ip_detection_threshold, allow_advertisement, auto_blacklist, detection_threshold_percent, state, detection_threshold_eps, blacklist_duration

Manage attack vector configuration in an AFM DoS profile. In addition to the normal AFM DoS profile vectors, this module can manage the device-configuration vectors. See the module documentation for details about this method.

Bigip Firewall Global Rules *arguments

Manage AFM global rule settings on BIG-IP

Arguments: enforced_policy, staged_policy, service_policy, description

Configures the global network firewall rules. These firewall rules are applied to all packets except those going through the management interface. They are applied first, before any firewall rules for the packet's virtual server, route domain, and/or self IP.

Bigip Firewall Log Profile *arguments

Manages AFM logging profiles configured in the system

Arguments: port_misuse, dos_protection, name, partition, ip_intelligence, state, description

Manages AFM logging profiles configured in the system along with basic information about each profile.

Bigip Firewall Log Profile Network *arguments

Configures Network Firewall related settings of the log profile

Arguments: log_tcp_events, log_storage_format, log_tcp_errors, log_matches_drop_rule, log_ip_errors, log_translation_fields, partition, rate_limit, log_format_delimiter, state, profile_name, log_message_fields, log_matches_reject_rule, log_publisher, log_matches_accept_rule

Configures Network Firewall related settings of the log profile.

Bigip Firewall Policy *arguments

Manage AFM security firewall policies on a BIG-IP

Arguments: rules, state, partition, name, description

Manages AFM security firewall policies on a BIG-IP.

Bigip Firewall Port List *arguments

Manage port lists on BIG-IP AFM

Arguments: state, name, port_ranges, description, partition, port_lists, ports

Manages the AFM port lists on a BIG-IP. This module can be used to add and remove port list entries.

Bigip Firewall Rule *arguments

Manage AFM Firewall rules

Arguments: status, rule_list, destination, protocol, description, schedule, irule, icmp_message, parent_policy, logging, name, partition, source, state, action, parent_rule_list

Manages firewall rules in an AFM firewall policy. New rules will always be added to the end of the policy. Rules can be re-ordered using the C(bigip_security_policy) module. Rules can also be pre-ordered using the C(bigip_security_policy) module and then later updated using the C(bigip_firewall_rule) module.

Bigip Firewall Rule List *arguments

Manage AFM security firewall policies on a BIG-IP

Arguments: rules, state, partition, name, description

Manages AFM security firewall policies on a BIG-IP.

Bigip Firewall Schedule *arguments

Manage BIG-IP AFM schedule configurations

Arguments: days_of_week, daily_hour_start, partition, date_valid_start, name, daily_hour_end, state, date_valid_end, description

Manage BIG-IP AFM schedule configurations.

Bigip Gtm Datacenter *arguments

Manage Datacenter configuration in BIG-IP

Arguments: state, contact, description, name, partition, location

Manage BIG-IP data center configuration. A data center defines the location where the physical network components reside, such as the server and link objects that share the same subnet on the network. This module is able to manipulate the data center definitions in a BIG-IP.

Bigip Gtm Global *arguments

Manages global GTM settings

Arguments: synchronization_group_name, synchronize_zone_files, synchronization

Manages global GTM settings. These settings include general, load balancing, and metrics related settings.

Bigip Gtm Monitor Bigip *arguments

Manages F5 BIG-IP GTM BIG-IP monitors

Arguments: interval, name, parent, ip, partition, aggregate_dynamic_ratios, state, ignore_down_response, timeout, port

Manages F5 BIG-IP GTM BIG-IP monitors. This monitor is used by GTM to monitor BIG-IPs themselves.

Bigip Gtm Monitor External *arguments

Manages external GTM monitors on a BIG-IP

Arguments: interval, name, parent, ip, variables, partition, state, arguments, timeout, external_program, port

Manages external GTM monitors on a BIG-IP.

Bigip Gtm Monitor Firepass *arguments

Manages F5 BIG-IP GTM FirePass monitors

Arguments: update_password, interval, parent, ip, cipher_list, concurrency_limit, target_username, max_load_average, name, partition, port, state, ignore_down_response, timeout, target_password, probe_timeout

Manages F5 BIG-IP GTM FirePass monitors.

Bigip Gtm Monitor Http *arguments

Manages F5 BIG-IP GTM http monitors

Arguments: update_password, interval, parent, ip, transparent, reverse, name, receive, partition, send, target_username, port, state, ignore_down_response, timeout, target_password, probe_timeout

Manages F5 BIG-IP GTM http monitors.

Bigip Gtm Monitor Https *arguments

Manages F5 BIG-IP GTM https monitors

Arguments: update_password, interval, parent, ip, port, cipher_list, compatibility, client_key, reverse, name, receive, partition, send, transparent, target_username, state, ignore_down_response, timeout, target_password, probe_timeout, client_cert

Manages F5 BIG-IP GTM https monitors.

Bigip Gtm Monitor Tcp *arguments

Manages F5 BIG-IP GTM tcp monitors

Arguments: interval, name, parent, receive, ip, partition, send, port, state, ignore_down_response, timeout, probe_timeout, transparent, reverse

Manages F5 BIG-IP GTM tcp monitors.

Bigip Gtm Monitor Tcp Half Open *arguments

Manages F5 BIG-IP GTM tcp half-open monitors

Arguments: probe_attempts, interval, name, parent, ip, partition, port, state, probe_interval, ignore_down_response, timeout, probe_timeout, transparent

Manages F5 BIG-IP GTM tcp half-open monitors.

Bigip Gtm Pool *arguments

Manages F5 BIG-IP GTM pools

Arguments: max_answers_returned, alternate_lb_method, name, partition, fallback_ip, preferred_lb_method, state, fallback_lb_method, availability_requirements, members, ttl, type, monitors

Manages F5 BIG-IP GTM pools.

Bigip Gtm Pool Member *arguments

Manage GTM pool member settings

Arguments: partition, ratio, monitor, limits, replace_all_with, server_name, member_order, state, aggregate, virtual_server, type, pool, description

Manages a variety of settings on GTM pool members. The settings that can be adjusted with this module are much more broad that what can be done in the C(bigip_gtm_pool) module. The pool module is intended to allow you to adjust the member order in the pool, not the various settings of the members. The C(bigip_gtm_pool_member) module should be used to adjust all of the other settings.

Bigip Gtm Server *arguments

Manages F5 BIG-IP GTM servers

Arguments: link_discovery, name, limits, datacenter, partition, server_type, monitors, state, prober_preference, prober_fallback, virtual_server_discovery, prober_pool, devices, iquery_options, availability_requirements

Manage BIG-IP server configuration. This module is able to manipulate the server definitions in a BIG-IP.

Bigip Gtm Topology Record *arguments

Manages GTM Topology Records

Arguments: source, state, destination, weight, partition

Manages GTM Topology Records. Once created, only topology record C(weight) can be modified.

Bigip Gtm Topology Region *arguments

Manages GTM Topology Regions

Arguments: region_members, partition, name, state

Manages GTM Topology Regions.

Bigip Gtm Virtual Server *arguments

Manages F5 BIG-IP GTM virtual servers

Arguments: partition, virtual_server_dependencies, translation_port, limits, server_name, translation_address, port, state, link, availability_requirements, address, monitors, name

Manages F5 BIG-IP GTM virtual servers. A GTM server can have many virtual servers associated with it. They are arranged in much the same way that pool members are to pools.

Bigip Gtm Wide Ip *arguments

Manages F5 BIG-IP GTM wide ip

Arguments: name, pool_lb_method, partition, last_resort_pool, irules, state, pools, type, aliases

Manages F5 BIG-IP GTM wide ip.

Bigip Hostname *arguments

Manage the hostname of a BIG-IP

Arguments: hostname

Manage the hostname of a BIG-IP.

Bigip Iapp Service *arguments

Manages TCL iApp services on a BIG-IP

Arguments: force, description, parameters, strict_updates, partition, device_group, state, template, traffic_group, metadata, name

Manages TCL iApp services on a BIG-IP. If you are looking for the API that is communicated with on the BIG-IP, the one the is used is C(/mgmt/tm/sys/application/service/).

Bigip Iapp Template *arguments

Manages TCL iApp templates on a BIG-IP

Arguments: content, state, partition, force, name

Manages TCL iApp templates on a BIG-IP. This module will allow you to deploy iApp templates to the BIG-IP and manage their lifecycle. The conventional way to use this module is to import new iApps as needed or by extracting the contents of the iApp archive that is provided at downloads.f5.com and then importing all the iApps with this module. This module can also update existing iApps provided that the source of the iApp changed while the name stayed the same. Note however that this module will not reconfigure any services that may have been created using the C(bigip_iapp_service) module. iApps are normally not updated in production. Instead, new versions are deployed and then existing services are changed to consume that new template. As such, the ability to update templates in-place requires the C(force) option to be used.

Bigip Ike Peer *arguments

Manage IPSec IKE Peer configuration on BIG-IP

Arguments: phase1_verify_peer_cert, update_password, verified_id_type, presented_id_type, description, remote_address, phase1_auth_method, phase1_key, phase1_hash_algorithm, phase1_cert, verified_id_value, name, presented_id_value, preshared_key, partition, phase1_perfect_forward_secrecy, state, version, phase1_encryption_algorithm

Manage IPSec IKE Peer configuration on BIG-IP.

Bigip Imish Config *arguments

Manage BIG-IP advanced routing configuration sections

Arguments: src, backup_options, after, lines, intended_config, diff_against, route_domain, parents, save_when, before, running_config, replace, backup, match, diff_ignore_lines

This module provides an implementation for working with advanced routing configuration sections in a deterministic way.

Bigip Ipsec Policy *arguments

Manage IPSec policies on a BIG-IP

Arguments: ipv4_interface, protocol, description, auth_algorithm, route_domain, perfect_forward_secrecy, encrypt_algorithm, lifetime, name, partition, tunnel_local_address, kb_lifetime, state, ipcomp, mode, tunnel_remote_address

Manage IPSec policies on a BIG-IP.

Bigip Irule *arguments

Manage iRules across different modules on a BIG-IP

Arguments: content, src, state, name, partition, module

Manage iRules across different modules on a BIG-IP.

Bigip Log Destination *arguments

Manages log destinations on a BIG-IP.

Arguments: protocol, description, pool_settings, transport_profile, syslog_format, forward_to, address, server_ssl_profile, port, pool, name, syslog_settings, partition, template_delete_delay, state, distribution, type, template_retransmit_interval

Manages log destinations on a BIG-IP.

Bigip Log Publisher *arguments

Manages log publishers on a BIG-IP

Arguments: description, state, partition, name, destinations

Manages log publishers on a BIG-IP.

Bigip Lx Package *arguments

Manages Javascript LX packages on a BIG-IP

Arguments: state, package

Manages Javascript LX packages on a BIG-IP. This module will allow you to deploy LX packages to the BIG-IP and manage their lifecycle.

Bigip Management Route *arguments

Manage system management routes on a BIG-IP

Arguments: state, network, name, partition, gateway, description

Configures route settings for the management interface of a BIG-IP.

Bigip Message Routing Peer *arguments

Manage peers for routing generic message protocol messages

Arguments: ratio, name, connection_mode, partition, auto_init_interval, state, auto_init, transport_config, number_of_connections, type, pool, description

Manage peers for routing generic message protocol messages.

Bigip Message Routing Protocol *arguments

Manage generic message parser profile.

Arguments: name, parent, max_msg_size, partition, max_egress_buffer, no_response, state, msg_terminator, disable_parser, description

Manages generic message parser profile for use with the message routing framework.

Bigip Message Routing Route *arguments

Manages static routes for routing message protocol messages

Arguments: peer_selection_mode, peers, name, src_address, partition, dst_address, state, type, description

Manages static routes for routing message protocol messages.

Bigip Message Routing Router *arguments

Manages router profiles for message-routing protocols

Arguments: ignore_client_port, description, parent, max_pending_messages, max_retries, mirrored_msg_sweeper_interval, mirror, name, inherited_traffic_group, type, partition, state, max_pending_bytes, routes, traffic_group, use_local_connection

Manages router profiles for message-routing protocols.

Bigip Message Routing Transport Config *arguments

Manages configuration for an outgoing connection

Arguments: src_port, name, rules, partition, profiles, state, src_addr_translation, type, description

Manages configuration for an outgoing connection in BIG-IP message routing.

Bigip Monitor Dns *arguments

Manage DNS monitors on a BIG-IP

Arguments: accept_rcode, interval, description, parent, ip, allowed_divergence_value, answer_section_contains, up_interval, port, reverse, sampling_timespan, name, receive, partition, adaptive_limit, allowed_divergence_type, state, time_until_up, query_name, manual_resume, timeout, query_type, adaptive, transparent

Manages DNS monitors on a BIG-IP.

Bigip Monitor External *arguments

Manages external LTM monitors on a BIG-IP

Arguments: interval, name, parent, ip, variables, partition, state, arguments, timeout, external_program, port, description

Manages external LTM monitors on a BIG-IP.

Bigip Monitor Gateway Icmp *arguments

Manages F5 BIG-IP LTM gateway ICMP monitors

Arguments: interval, description, parent, ip, up_interval, port, sampling_timespan, name, time_until_up, partition, adaptive_limit, allowed_divergence_type, state, allowed_divergence_value, manual_resume, timeout, adaptive, transparent

Manages gateway ICMP monitors on a BIG-IP.

Bigip Monitor Http *arguments

Manages F5 BIG-IP LTM http monitors

Arguments: interval, description, parent, ip, target_username, receive_disable, reverse, receive, name, partition, send, port, state, time_until_up, timeout, target_password

Manages F5 BIG-IP LTM http monitors.

Bigip Monitor Https *arguments

Manages F5 BIG-IP LTM https monitors

Arguments: interval, description, parent, ssl_profile, ip, up_interval, target_username, name, receive_disable, receive, partition, send, port, state, time_until_up, timeout, target_password

Manages F5 BIG-IP LTM https monitors.

Bigip Monitor Ldap *arguments

Manages BIG-IP LDAP monitors

Arguments: update_password, interval, description, parent, ip, chase_referrals, mandatory_attributes, base, up_interval, target_username, name, partition, port, filter, state, time_until_up, manual_resume, timeout, debug, target_password, security

Manages BIG-IP LDAP monitors.

Bigip Monitor Snmp Dca *arguments

Manages BIG-IP SNMP data collecting agent (DCA) monitors

Arguments: interval, disk_threshold, parent, community, cpu_threshold, description, name, cpu_coefficient, time_until_up, partition, memory_threshold, disk_coefficient, state, version, agent_type, memory_coefficient, timeout

The BIG-IP has an SNMP data collecting agent (DCA) that can query remote SNMP agents of various types, including the UC Davis agent (UCD) and the Windows 2000 Server agent (WIN2000).

Bigip Monitor Tcp *arguments

Manages F5 BIG-IP LTM tcp monitors

Arguments: interval, name, parent, receive, ip, partition, send, state, time_until_up, timeout, port, description

Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API.

Bigip Monitor Tcp Echo *arguments

Manages F5 BIG-IP LTM tcp echo monitors

Arguments: interval, name, parent, ip, partition, state, time_until_up, timeout, description

Manages F5 BIG-IP LTM tcp echo monitors.

Bigip Monitor Tcp Half Open *arguments

Manages F5 BIG-IP LTM tcp half-open monitors

Arguments: interval, name, parent, ip, partition, state, time_until_up, timeout, port, description

Manages F5 BIG-IP LTM tcp half-open monitors.

Bigip Monitor Udp *arguments

Manages F5 BIG-IP LTM udp monitors

Arguments: interval, receive_disable, parent, receive, ip, partition, send, name, state, time_until_up, timeout, port, description

Manages F5 BIG-IP LTM udp monitors.

Bigip Node *arguments

Manages F5 BIG-IP LTM nodes

Arguments: description, fqdn_auto_populate, rate_limit, fqdn_up_interval, address, monitors, name, ratio, quorum, fqdn_address_type, partition, connection_limit, fqdn, monitor_type, state, availability_requirements, fqdn_down_interval, dynamic_ratio

Manages F5 BIG-IP LTM nodes.

Bigip Partition *arguments

Manage BIG-IP partitions

Arguments: route_domain, description, state, name

Manage BIG-IP partitions.

Bigip Password Policy *arguments

Manages the authentication password policy on a BIG-IP

Arguments: password_memory, max_duration, required_special, required_uppercase, min_length, max_login_failures, min_duration, required_lowercase, policy_enforcement, expiration_warning, required_numeric

Manages the authentication password policy on a BIG-IP.

Bigip Policy *arguments

Manage general policy configuration on a BIG-IP

Arguments: state, description, name, rules, partition, strategy

Manages general policy configuration on a BIG-IP. This module is best used in conjunction with the C(bigip_policy_rule) module. This module can handle general configuration like setting the draft state of the policy, the description, and things unrelated to the policy rules themselves. It is also the first module that should be used when creating rules as the C(bigip_policy_rule) module requires a policy parameter.

Bigip Policy Rule *arguments

Manage LTM policy rules on a BIG-IP

Arguments: state, description, policy, partition, conditions, actions, name

This module will manage LTM policy rules on a BIG-IP.

Bigip Pool *arguments

Manages F5 BIG-IP LTM pools

Arguments: monitors, lb_method, quorum, replace_all_with, priority_group_activation, partition, slow_ramp_time, service_down_action, reselect_tries, state, description, aggregate, metadata, monitor_type, name

Manages F5 BIG-IP LTM pools via iControl REST API.

Bigip Pool Member *arguments

Manages F5 BIG-IP LTM pool members

Arguments: description, replace_all_with, fqdn_auto_populate, connection_limit, ip_encapsulation, preserve_node, address, aggregate, monitors, pool, ratio, name, partition, rate_limit, fqdn, reuse_nodes, port, state, availability_requirements, priority_group

Manages F5 BIG-IP LTM pool members via iControl SOAP API.

Bigip Profile Analytics *arguments

Manage HTTP analytics profiles on a BIG-IP

Arguments: partition, description, parent, notification_by_email, external_logging_publisher, collect_max_tps_and_throughput, collected_stats_external_logging, name, collect_ip, collect_geo, collect_user_sessions, notification_by_syslog, collect_page_load_time, state, collected_stats_internal_logging, collect_url, collect_user_agent, notification_email_addresses

Manage HTTP analytics profiles on a BIG-IP.

Bigip Profile Client Ssl *arguments

Manages client SSL profiles on a BIG-IP

Arguments: ciphers, allow_non_ssl, cert_key_chain, sni_require, client_auth_frequency, cert_auth_depth, client_auth_crl, allow_expired_crl, retain_certificate, advertised_cert_authority, strict_resume, name, parent, server_name, secure_renegotiation, partition, options, state, renegotiation, sni_default, trusted_cert_authority, client_certificate

Manages client SSL profiles on a BIG-IP.

Bigip Profile Dns *arguments

Manage DNS profiles on a BIG-IP

Arguments: enable_dns_firewall, enable_zone_transfer, name, parent, process_recursion_desired, unhandled_query_action, enable_cache, enable_dns_express, partition, state, use_local_bind, enable_gtm, enable_dnssec, cache_name

Manage DNS profiles on a BIG-IP. Many DNS profiles; each with their own adjustments to the standard C(dns) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Bigip Profile Fastl4 *arguments

Manages Fast L4 profiles

Arguments: ip_df_mode, receive_window_size, tcp_handshake_timeout, ip_tos_to_client, tcp_timestamp_mode, late_binding, mss_override, tcp_close_timeout, server_timestamp, link_qos_to_server, state, tcp_time_wait_timeout, tcp_strip_sack, reassemble_fragments, ip_ttl_mode, ip_ttl_v6, ip_ttl_v4, loose_initialization, keep_alive_interval, description, parent, idle_timeout, timeout_recovery, name, server_sack, reset_on_timeout, partition, tcp_wscale_mode, rtt_from_client, rtt_from_server, explicit_flow_migration, ip_tos_to_server, link_qos_to_client, client_timeout, loose_close, tcp_generate_isn, syn_cookie_mss

Manages Fast L4 profiles.

Bigip Profile Http *arguments

Manage HTTP profiles on a BIG-IP

Arguments: enforcement, update_password, request_chunking, description, parent, insert_xforwarded_for, header_insert, fallback_host, maximum_age, accept_xff, dns_resolver, hsts_mode, encrypt_cookies, fallback_status_codes, server_agent_name, sflow, name, encrypt_cookie_secret, xff_alternative_names, partition, response_chunking, state, oneconnect_transformations, redirect_rewrite, header_erase, include_subdomains, proxy_type

Manage HTTP profiles on a BIG-IP.

Bigip Profile Http Compression *arguments

Manage HTTP compression profiles on a BIG-IP

Arguments: name, parent, partition, gzip_window_size, state, gzip_memory_level, buffer_size, gzip_level, description

Manage HTTP compression profiles on a BIG-IP.

Bigip Profile Http2 *arguments

Manage HTTP2 profiles on a BIG-IP

Arguments: receive_window, insert_header_name, name, parent, activation_modes, partition, idle_timeout, write_size, state, enforce_tls_requirements, streams, frame_size, insert_header, header_table_size, description

Manage HTTP2 profiles on a BIG-IP.

Bigip Profile Oneconnect *arguments

Manage OneConnect profiles on a BIG-IP

Arguments: idle_timeout_override, source_mask, name, parent, maximum_reuse, partition, maximum_age, limit_type, state, maximum_size, share_pools, description

Manage OneConnect profiles on a BIG-IP.

Bigip Profile Persistence Cookie *arguments

Manage cookie persistence profiles on BIG-IP

Arguments: update_password, secure, parent, cookie_name, cookie_encryption, encrypt_cookie_pool_name, match_across_virtuals, always_send, cookie_method, name, match_across_pools, description, partition, match_across_services, state, expiration, override_connection_limit, http_only, encryption_passphrase

Manage cookie persistence profiles on BIG-IP.

Bigip Profile Persistence Src Addr *arguments

Manage source address persistence profiles

Arguments: name, parent, match_across_pools, entry_timeout, partition, match_across_services, state, match_across_virtuals, hash_algorithm, override_connection_limit

Manages source address persistence profiles.

Bigip Profile Server Ssl *arguments

Manages server SSL profiles on a BIG-IP

Arguments: update_password, ciphers, passphrase, parent, sni_require, server_certificate, key, name, server_name, secure_renegotiation, partition, ocsp_profile, state, certificate, chain, sni_default

Manages server SSL profiles on a BIG-IP.

Bigip Profile Tcp *arguments

Manage TCP profiles on a BIG-IP

Arguments: name, parent, initial_congestion_window_size, partition, proxy_options, syn_rto_base, idle_timeout, state, initial_receive_window_size, time_wait_recycle, nagle, early_retransmit

Manage TCP profiles on a BIG-IP. Many TCP profiles; each with their own adjustments to the standard C(tcp) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Bigip Profile Udp *arguments

Manage UDP profiles on a BIG-IP

Arguments: idle_timeout, datagram_load_balancing, name, parent, partition, state

Manage UDP profiles on a BIG-IP. Many of UDP profiles exist; each with their own adjustments to the standard C(udp) profile. Users of this module should be aware that many of the adjustable knobs have no module default. Instead, the default is assigned by the BIG-IP system itself which, in most cases, is acceptable.

Bigip Provision *arguments

Manage BIG-IP module provisioning

Arguments: state, level, module, memory

Manage BIG-IP module provisioning. This module will only provision at the standard levels of Dedicated, Nominal, and Minimum.

Bigip Qkview *arguments

Manage qkviews on the device

Arguments: max_file_size, force, asm_request_log, dest, filename, exclude_core, complete_information, exclude

Manages creating and downloading qkviews from a BIG-IP. Various options can be provided when creating qkviews. The qkview is important when dealing with F5 support. It may be required that you upload this qkview to the supported channels during resolution of an SRs that you may have opened.

Bigip Remote Role *arguments

Manage remote roles on a BIG-IP

Arguments: attribute_string, line_order, name, terminal_access, partition_access, state, remote_access, assigned_role

Manages remote roles on a BIG-IP. Remote roles are used in situations where user authentication is handled off-box. Local access control to the BIG-IP is controlled by the defined remote role. Where-as authentication (and by extension, assignment to the role) is handled off-box.

Bigip Remote Syslog *arguments

Manipulate remote syslog settings on a BIG-IP

Arguments: state, remote_port, remote_host, name, local_ip

Manipulate remote syslog settings on a BIG-IP.

Bigip Remote User *arguments

Manages default settings for remote user accounts on a BIG-IP

Arguments: console_access, default_partition, default_role, description

Manages default settings for remote user accounts on a BIG-IP.

Bigip Routedomain *arguments

Manage route domains on a BIG-IP

Arguments: flow_eviction_policy, service_policy, description, parent, partition, connection_limit, name, strict, state, routing_protocol, bwc_policy, vlans, id, fw_enforced_policy

Manage route domains on a BIG-IP.

Bigip Selfip *arguments

Manage Self-IPs on a BIG-IP system

Arguments: vlan, description, partition, state, allow_service, netmask, route_domain, address, traffic_group, name

Manage Self-IPs on a BIG-IP system.

Bigip Service Policy *arguments

Manages service policies on a BIG-IP.

Arguments: state, port_misuse_policy, name, timer_policy, partition, description

Service policies allow you to configure timers and port misuse rules, if enabled, on a per rule or per context basis.

Bigip Smtp *arguments

Manages SMTP settings on the BIG-IP

Arguments: smtp_server_port, smtp_server_username, update_password, from_address, encryption, partition, smtp_server, authentication, state, local_host_name, smtp_server_password, name

Allows configuring of the BIG-IP to send mail via an SMTP server by configuring the parameters of an SMTP server.

Bigip Snat Pool *arguments

Manage SNAT pools on a BIG-IP

Arguments: state, partition, description, members, name

Manage SNAT pools on a BIG-IP.

Bigip Snat Translation *arguments

Manage SNAT Translations on a BIG-IP

Arguments: arp, description, tcp_idle_timeout, udp_idle_timeout, partition, connection_limit, state, ip_idle_timeout, address, traffic_group, name

Manage SNAT Translations on a BIG-IP.

Bigip Snmp *arguments

Manipulate general SNMP settings on a BIG-IP

Arguments: contact, location, agent_status_traps, allowed_addresses, agent_authentication_traps, device_warning_traps

Manipulate general SNMP settings on a BIG-IP.

Bigip Snmp Community *arguments

Manages SNMP communities on a BIG-IP.

Arguments: snmp_privacy_protocol, update_password, oid, community, snmp_auth_protocol, port, snmp_privacy_password, name, source, partition, access, snmp_auth_password, state, version, snmp_username, ip_version

Assists in managing SNMP communities on a BIG-IP. Different SNMP versions are supported by this module. Take note of the different parameters offered by this module, as different parameters work for different versions of SNMP. Typically this becomes an interest if you are mixing versions C(v2c) and C(3).

Bigip Snmp Trap *arguments

Manipulate SNMP trap information on a BIG-IP

Arguments: snmp_version, destination, network, partition, community, state, port, name

Manipulate SNMP trap information on a BIG-IP.

Bigip Software Image *arguments

Manage software images on a BIG-IP

Arguments: state, force, image

Manages software images on a BIG-IP. These images may include both base images and hotfix images.

Bigip Software Install *arguments

Install software images on a BIG-IP

Arguments: volume, image, state

Install new images on a BIG-IP.

Bigip Software Update *arguments

Manage the software update settings of a BIG-IP

Arguments: auto_phone_home, auto_check, frequency

Manage the software update settings of a BIG-IP.

Bigip Ssl Certificate *arguments

Import/Delete certificates from BIG-IP

Arguments: content, issuer_cert, state, partition, name

This module will import/delete SSL certificates on BIG-IP LTM. Certificates can be imported from certificate and key files on the local disk, in PEM format.

Bigip Ssl Key *arguments

Import/Delete SSL keys from BIG-IP

Arguments: content, state, partition, name, passphrase

This module will import/delete SSL keys on a BIG-IP. Keys can be imported from key files on the local disk, in PEM format.

Bigip Ssl Ocsp *arguments

Manage OCSP configurations on BIG-IP

Arguments: update_password, passphrase, strict_responder_checking, connections_limit, dns_resolver, key, clock_skew, responder_url, connection_timeout, cache_timeout, name, certificate, partition, cache_error_timeout, status_age, state, trusted_responders, route_domain, hash_algorithm, proxy_server_pool

Manage OCSP configurations on BIG-IP.

Bigip Static Route *arguments

Manipulate static routes on a BIG-IP

Arguments: partition, gateway_address, name, vlan, route_domain, mtu, state, reject, destination, netmask, pool, description

Manipulate static routes on a BIG-IP.

Bigip Sys Daemon Log Tmm *arguments

Manage BIG-IP tmm daemon log settings

Arguments: http_compression_log_level, pva_log_level, layer4_log_level, ip_log_level, arp_log_level, http_log_level, state, os_log_level, ssl_log_level, net_log_level, irule_log_level

Manage BIG-IP tmm log settings.

Bigip Sys Db *arguments

Manage BIG-IP system database variables

Arguments: state, key, value

Manage BIG-IP system database variables

Bigip Sys Global *arguments

Manage BIG-IP global settings

Arguments: security_banner, net_reboot, banner_text, console_timeout, quiet_boot, mgmt_dhcp, state, gui_setup, lcd_display

Manage BIG-IP global settings.

Bigip Timer Policy *arguments

Manage timer policies on a BIG-IP

Arguments: rules, state, partition, name, description

Manage timer policies on a BIG-IP.

Bigip Traffic Selector *arguments

Manage IPSec Traffic Selectors on BIG-IP

Arguments: description, partition, state, destination_address, ipsec_policy, source_address, order, name

Manage IPSec Traffic Selectors on BIG-IP.

Bigip Trunk *arguments

Manage trunks on a BIG-IP

Arguments: frame_distribution_hash, name, interfaces, lacp_mode, link_selection_policy, lacp_timeout, state, qinq_ethertype, lacp_enabled, description

Manages trunks on a BIG-IP.

Bigip Tunnel *arguments

Manage tunnels on a BIG-IP

Arguments: profile, description, secondary_address, remote_address, auto_last_hop, key, transparent, name, tos, partition, mtu, state, mode, use_pmtu, local_address, traffic_group

Manages tunnels on a BIG-IP. Tunnels are usually based upon a tunnel profile which defines both default arguments and constraints for the tunnel. Due to this, this module exposes a number of settings that may or may not be related to the type of tunnel you are working with. It is important that you take this into consideration when declaring your tunnel config. If a specific tunnel does not support the parameter you are considering, the documentation of the parameter will usually make mention of this. Otherwise, when configuring that parameter on the device, the device will notify you.

Bigip Ucs *arguments

Manage upload, installation and removal of UCS files

Arguments: force, reset_trust, no_platform_check, state, include_chassis_level_config, passphrase, ucs, no_license

Manage upload, installation and removal of UCS files.

Bigip Ucs Fetch *arguments

Fetches a UCS file from remote nodes

Arguments: create_on_missing, src, force, fail_on_missing, encryption_password, dest, backup

This module is used for fetching UCS files from remote machines and storing them locally in a file tree, organized by hostname. Note that this module is written to transfer UCS files that might not be present, so a missing remote UCS won't be an error unless fail_on_missing is set to 'yes'.

Bigip User *arguments

Manage user accounts and user attributes on a BIG-IP

Arguments: update_password, shell, password_credential, partition_access, partition, state, full_name, username_credential

Manage user accounts and user attributes on a BIG-IP. Typically this module operates only on the REST API users and not the CLI users. When specifying C(root), you may only change the password. Your other parameters will be ignored in this case. Changing the C(root) password is not an idempotent operation. Therefore, it will change it every time this module attempts to change it.

Bigip Vcmp Guest *arguments

Manages vCMP guests on a BIG-IP

Arguments: mgmt_address, vlans, name, allowed_slots, delete_virtual_disk, partition, number_of_slots, initial_image, state, min_number_of_slots, mgmt_route, mgmt_network, cores_per_slot, initial_hotfix

Manages vCMP guests on a BIG-IP. This functionality only exists on actual hardware and must be enabled by provisioning C(vcmp) with the C(bigip_provision) module.

Bigip Virtual Address *arguments

Manage LTM virtual addresses on a BIG-IP

Arguments: arp, icmp_echo, name, auto_delete, partition, connection_limit, state, availability_calculation, route_domain, arp_state, address, traffic_group, netmask, route_advertisement, spanning

Manage LTM virtual addresses on a BIG-IP.

Bigip Virtual Server *arguments

Manage LTM virtual servers on a BIG-IP

Arguments: rate_limit_src_mask, fallback_persistence_profile, mask, default_persistence_profile, insert_metadata, firewall_enforced_policy, enabled_vlans, mirror, port, description, destination, rate_limit_mode, irules, source, state, pool, security_nat_policy, ip_intelligence_policy, address_translation, snat, metadata, disabled_vlans, ip_protocol, firewall_staged_policy, rate_limit_dst_mask, security_log_profiles, name, type, partition, rate_limit, profiles, clone_pools, policies, source_port, port_translation

Manage LTM virtual servers on a BIG-IP.

Bigip Vlan *arguments

Manage VLANs on a BIG-IP system

Arguments: fail_safe_timeout, tagged_interfaces, untagged_interfaces, interfaces, sflow_poll_interval, sflow_sampling_rate, tag, source_check, cmp_hash, dag_tunnel, fail_safe, dag_round_robin, name, description, partition, mtu, fail_safe_action, state

Manage VLANs on a BIG-IP system

Bigip Wait *arguments

Wait for a BIG-IP condition before continuing

Arguments: delay, msg, sleep, timeout

You can wait for BIG-IP to be "ready". By "ready", we mean that BIG-IP is ready to accept configuration. This module can take into account situations where the device is in the middle of rebooting due to a configuration change.

Bigiq Application Fasthttp *arguments

Manages BIG-IQ FastHTTP applications

Arguments: service_environment, name, add_analytics, description, servers, state, inbound_virtual, wait

Manages BIG-IQ applications used for load balancing an HTTP-based application, speeding up connections and reducing the number of connections to the back-end server.

Bigiq Application Fastl4 Tcp *arguments

Manages BIG-IQ FastL4 TCP applications

Arguments: service_environment, name, add_analytics, description, servers, state, inbound_virtual, wait

Manages BIG-IQ applications used for load balancing a TCP-based application with a FastL4 profile.

Bigiq Application Fastl4 Udp *arguments

Manages BIG-IQ FastL4 UDP applications

Arguments: service_environment, name, add_analytics, description, servers, state, inbound_virtual, wait

Manages BIG-IQ applications used for load balancing a UDP-based application with a FastL4 profile.

Bigiq Application Http *arguments

Manages BIG-IQ HTTP applications

Arguments: service_environment, name, add_analytics, description, servers, state, inbound_virtual, wait

Manages BIG-IQ applications used for load balancing an HTTP application on port 80 on BIG-IP.

Bigiq Application Https Offload *arguments

Manages BIG-IQ HTTPS offload applications

Arguments: service_environment, name, add_analytics, description, servers, state, redirect_virtual, inbound_virtual, client_ssl_profile, wait

Manages BIG-IQ applications used for load balancing an HTTPS application on port 443 with SSL offloading on BIG-IP.

Bigiq Application Https Waf *arguments

Manages BIG-IQ HTTPS WAF applications

Arguments: service_environment, name, add_analytics, description, domain_names, servers, state, redirect_virtual, inbound_virtual, client_ssl_profile, wait

Manages BIG-IQ applications used for load balancing an HTTPS application on port 443 with a Web Application Firewall (WAF) using an ASM Rapid Deployment policy.

Bigiq Device Discovery *arguments

Manage BIG-IP devices through BIG-IQ

Arguments: device_address, force, access_group_first_device, access_group_name, ha_name, device_username, statistics, access_conflict_policy, use_bigiq_sync, modules, device_conflict_policy, versioned_conflict_policy, state, device_port, conflict_policy, device_password

Discovers and imports BIG-IP device configuration on the BIG-IQ.

Bigiq Device Info *arguments

Collect information from F5 BIG-IQ devices

Arguments: gather_subset

Collect information from F5 BIG-IQ devices. This module was called C(bigiq_device_facts) before Ansible 2.9. The usage did not change.

Bigiq Regkey License *arguments

Manages licenses in a BIG-IQ registration key pool

Arguments: license_key, regkey_pool, accept_eula, description, state

Manages licenses in a BIG-IQ registration key pool.

Bigiq Regkey License Assignment *arguments

Manage regkey license assignment on BIG-IPs from a BIG-IQ

Arguments: device_username, managed, state, device_port, key, device, device_password, pool

Manages the assignment of regkey licenses on a BIG-IQ. Assignment means that the license is assigned to a BIG-IP, or, it needs to be assigned to a BIG-IP. Additionally, this module supported revoking the assignments from BIG-IP devices.

Bigiq Regkey Pool *arguments

Manages registration key pools on BIG-IQ

Arguments: state, name, description

Manages registration key (regkey) pools on a BIG-IQ. These pools function as a container in-which you will add lists of registration keys. To add registration keys, use the C(bigiq_regkey_license) module.

Bigiq Utility License *arguments

Manage utility licenses on a BIG-IQ

Arguments: license_key, accept_eula, state

Manages utility licenses on a BIG-IQ. Utility licenses are one form of licenses that BIG-IQ can distribute. These licenses, unlike regkey licenses, do not require a pool to be created before creation. Additionally, when assigning them, you assign by offering instead of key.

Bigiq Utility License Assignment *arguments

Manage utility license assignment on BIG-IPs from a BIG-IQ

Arguments: device_username, managed, offering, state, device_port, key, device, unit_of_measure, device_password

Manages the assignment of utility licenses on a BIG-IQ. Assignment means that the license is assigned to a BIG-IP, or, it needs to be assigned to a BIG-IP. Additionally, this module supported revoking the assignments from BIG-IP devices.

Bigmon Chain *arguments

Create and remove a bigmon inline service chain.

Arguments: access_token, state, validate_certs, controller, name

Create and remove a bigmon inline service chain.

Bigmon Policy *arguments

Create and remove a bigmon out-of-band policy.

Arguments: policy_description, name, access_token, start_time, state, priority, action, controller, duration, validate_certs, delivery_packet_count

Create and remove a bigmon out-of-band policy.

Bigpanda *arguments

Notify BigPanda about deployments

Arguments: description, url, component, token, state, version, hosts, env, owner, validate_certs

Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls.

Bitbucket Access Key *arguments

Manages Bitbucket repository access keys

Arguments: username, state, client_id, repository, key, client_secret, label

Manages Bitbucket repository access keys (also called deploy keys).

Bitbucket Pipeline Key Pair *arguments

Manages Bitbucket pipeline SSH key pair

Arguments: username, public_key, private_key, client_id, repository, client_secret, state

Manages Bitbucket pipeline SSH key pair.

Bitbucket Pipeline Known Host *arguments

Manages Bitbucket pipeline known hosts

Arguments: username, key, state, repository, client_id, client_secret, name

Manages Bitbucket pipeline known hosts under the "SSH Keys" menu. The host fingerprint will be retrieved automatically, but in case of an error, one can use I(key) field to specify it manually.

Bitbucket Pipeline Variable *arguments

Manages Bitbucket pipeline variables

Arguments: username, name, repository, secured, value, state, client_id, client_secret

Manages Bitbucket pipeline variables.

Blockinfile *arguments

Insert/update/remove a text block surrounded by marker lines

Arguments: insertbefore, backup, create, marker, state, block, insertafter, path, marker_begin, marker_end

This module will insert/update/remove a block of multi-line text surrounded by customizable marker lines.

Bower *arguments

Manage bower packages with bower

Arguments: state, production, name, version, relative_execpath, path, offline

Manage bower packages with bower

Bundler *arguments

Manage Ruby Gem dependencies with Bundler

Arguments: executable, chdir, gemfile, clean, user_install, extra_args, state, deployment_mode, binstub_directory, exclude_groups, local, gem_path

Manage installation and Gem version dependencies for Ruby using the Bundler gem

Bzr *arguments

Deploy software (or files) from bzr branches

Arguments: dest, executable, version, force, name

Manage I(bzr) branches to deploy files or software.

Campfire *arguments

Send a message to Campfire

Arguments: msg, token, subscription, notify, room

Send a message to Campfire. Messages with newlines will result in a "Paste" message being sent.

Capabilities *arguments

Manage Linux capabilities

Arguments: capability, path, state

This module manipulates files privileges using the Linux capabilities(7) system.

Catapult *arguments

Send a sms / mms using the catapult bandwidth api

Arguments: src, user_id, api_secret, dest, media, api_token, msg

Allows notifications to be sent using sms / mms via the catapult bandwidth api.

Ce Aaa Server *arguments

Manages AAA server global configuration on HUAWEI CloudEngine switches.

Arguments: acct_scheme_name, first_author_mode, authen_scheme_name, author_scheme_name, radius_server_group, domain_name, first_authen_mode, state, local_user_group, hwtacas_template, accounting_mode

Manages AAA server global configuration on HUAWEI CloudEngine switches.

Ce Aaa Server Host *arguments

Manages AAA server host configuration on HUAWEI CloudEngine switches.

Arguments: radius_server_port, hwtacacs_server_ipv6, local_service_type, radius_server_name, radius_server_mode, hwtacacs_server_type, radius_vpn_name, radius_server_ipv6, radius_server_type, hwtacacs_server_ip, local_user_group, local_user_level, radius_server_ip, local_ftp_dir, hwtacacs_vpn_name, hwtacacs_is_secondary_server, radius_group_name, hwtacacs_template, local_password, state, hwtacacs_server_host_name, local_user_name, hwtacacs_is_public_net

Manages AAA server host configuration on HUAWEI CloudEngine switches.

Ce Acl *arguments

Manages base ACL configuration on HUAWEI CloudEngine switches.

Arguments: acl_step, acl_name, log_flag, source_ip, state, src_mask, rule_action, rule_name, acl_num, vrf_name, acl_description, rule_id, time_range, rule_description, frag_type

Manages base ACL configurations on HUAWEI CloudEngine switches.

Ce Acl Advance *arguments

Manages advanced ACL configuration on HUAWEI CloudEngine switches.

Arguments: acl_step, protocol, precedence, src_port_op, log_flag, time_range, src_port_begin, frag_type, dest_port_op, dest_pool_name, acl_description, ttl_expired, icmp_type, src_mask, icmp_name, established, igmp_type, tos, acl_num, rule_action, state, tcp_flag_mask, src_port_end, dest_ip, icmp_code, dest_port_end, acl_name, dscp, rule_name, rule_description, dest_mask, src_port_pool_name, source_ip, syn_flag, vrf_name, src_pool_name, dest_port_begin, dest_port_pool_name, rule_id

Manages advanced ACL configurations on HUAWEI CloudEngine switches.

Ce Acl Interface *arguments

Manages applying ACLs to interfaces on HUAWEI CloudEngine switches.

Arguments: interface, direction, state, acl_name

Manages applying ACLs to interfaces on HUAWEI CloudEngine switches.

Ce Bfd Global *arguments

Manages BFD global configuration on HUAWEI CloudEngine devices.

Arguments: tos_exp_dynamic, default_ip, damp_init_wait_time, bfd_enable, delay_up_time, state, damp_max_wait_time, damp_second_wait_time, tos_exp_static

Manages BFD global configuration on HUAWEI CloudEngine devices.

Ce Bfd Session *arguments

Manages BFD session configuration on HUAWEI CloudEngine devices.

Arguments: local_discr, src_addr, out_if_name, state, dest_addr, vrf_name, create_type, remote_discr, session_name, use_default_ip, addr_type

Manages BFD session configuration, creates a BFD session or deletes a specified BFD session on HUAWEI CloudEngine devices.

Ce Bfd View *arguments

Manages BFD session view configuration on HUAWEI CloudEngine devices.

Arguments: local_discr, detect_multi, remote_discr, description, admin_down, tos_exp, min_tx_interval, min_rx_interval, state, session_name, wtr_interval

Manages BFD session view configuration on HUAWEI CloudEngine devices.

Ce Bgp *arguments

Manages BGP configuration on HUAWEI CloudEngine switches.

Arguments: router_id, memory_limit, vrf_rid_auto_sel, suppress_interval, as_number, confed_id_number, bgp_rid_auto_sel, default_af_type, conn_retry_time, is_shutdown, keepalive_time, confed_peer_as_num, min_hold_time, ebgp_if_sensitive, check_first_as, clear_interval, confed_nonstanded, time_wait_for_rib, hold_time, as_path_limit, hold_interval, state, vrf_name, keep_all_routes, gr_peer_reset, graceful_restart

Manages BGP configurations on HUAWEI CloudEngine switches.

Ce Bgp Af *arguments

Manages BGP Address-family configuration on HUAWEI CloudEngine switches.

Arguments: reflector_cluster_id, ingress_lsp_policy_name, vrf_rid_auto_sel, preference_internal, maximum_load_balance, preference_local, preference_external, router_id_neglect, default_local_pref, reflector_cluster_ipv4, prefrence_policy_name, default_rt_import_enable, nhp_relay_route_policy_name, igp_metric_ignore, as_path_neglect, auto_frr_enable, mask_len, ibgp_ecmp_nexthop_changed, af_type, nexthop_third_party, state, default_med, add_path_sel_num, med_none_as_maximum, ebgp_ecmp_nexthop_changed, ecmp_nexthop_changed, lowest_priority, rr_filter_number, import_process_id, router_id, determin_med, load_balancing_as_path_ignore, reflect_chg_path, always_compare_med, allow_invalid_as, relay_delay_enable, rib_only_policy_name, max_load_ebgp_num, import_protocol, ebgp_if_sensitive, network_address, supernet_uni_adv, next_hop_sel_depend_type, originator_prior, active_route_advertise, reflect_between_client, policy_vpn_target, summary_automatic, rib_only_enable, max_load_ibgp_num, route_sel_delay, supernet_label_adv, vrf_name, policy_ext_comm_enable

Manages BGP Address-family configurations on HUAWEI CloudEngine switches.

Ce Bgp Neighbor *arguments

Manages BGP peer configuration on HUAWEI CloudEngine switches.

Arguments: prepend_global_as, ebgp_max_hop, is_ignore, prepend_fake_as, fake_as, is_single_hop, conventional, remote_as, hold_time, tx_interval, pswd_cipher_text, local_if_name, rx_interval, state, vrf_name, dual_as, connect_mode, description, is_log_change, keep_alive_time, key_chain_name, conn_retry_time, min_hold_time, multiplier, valid_ttl_hops, is_bfd_block, tcp_MSS, is_bfd_enable, route_refresh, peer_addr, pswd_type, mpls_local_ifnet_disable

Manages BGP peer configurations on HUAWEI CloudEngine switches.

Ce Bgp Neighbor Af *arguments

Manages BGP neighbor Address-family configuration on HUAWEI CloudEngine switches.

Arguments: import_pref_filt_name, advertise_irb, substitute_as_enable, advertise_ext_community, default_rt_match_mode, redirect_ip, route_limit, import_as_path_filter, public_as_only_force, vpls_enable, allow_as_loop_enable, advertise_arp, import_as_path_name_or_num, af_type, orf_mode, nexthop_configure, discard_ext_community, is_nonstd_ipprefix_mod, keep_all_routes, orftype, advertise_community, export_as_path_name_or_num, adv_add_path_num, ipprefix_orf_enable, route_limit_type, remote_address, public_as_only_skip_peer_as, origin_as_valid, route_limit_idle_timeout, reflect_client, import_rt_policy_name, route_limit_percent, export_rt_policy_name, public_as_only, redirect_ip_vaildation, import_acl_name_or_num, allow_as_loop_limit, add_path_mode, export_as_path_filter, vpls_ad_disable, public_as_only_replace, public_as_only_limited, preferred_value, export_acl_name_or_num, soostring, update_pkt_standard_compatible, advertise_remote_nexthop, vrf_name, default_rt_adv_policy, export_pref_filt_name, default_rt_adv_enable, rt_updt_interval

Manages BGP neighbor Address-family configurations on HUAWEI CloudEngine switches.

Ce Command *arguments

Run arbitrary command on HUAWEI CloudEngine devices.

Arguments: retries, commands, wait_for, match, interval

Sends an arbitrary command to an HUAWEI CloudEngine node and returns the results read from the device. The ce_command module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Ce Config *arguments

Manage Huawei CloudEngine configuration sections.

Arguments: src, backup_options, backup, after, lines, replace, parents, defaults, save, config, match, before

Huawei CloudEngine configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with CloudEngine configuration sections in a deterministic way. This module works with CLI transports.

Ce Dldp *arguments

Manages global DLDP configuration on HUAWEI CloudEngine switches.

Arguments: reset, enable, work_mode, auth_pwd, time_internal, auth_mode

Manages global DLDP configuration on HUAWEI CloudEngine switches.

Ce Dldp Interface *arguments

Manages interface DLDP configuration on HUAWEI CloudEngine switches.

Arguments: reset, state, enable, interface, mode_enable, local_mac

Manages interface DLDP configuration on HUAWEI CloudEngine switches.

Ce Eth Trunk *arguments

Manages Eth-Trunk interfaces on HUAWEI CloudEngine switches.

Arguments: state, force, mode, members, min_links, trunk_id, hash_type

Manages Eth-Trunk specific configuration parameters on HUAWEI CloudEngine switches.

Ce Evpn Bd Vni *arguments

Manages EVPN VXLAN Network Identifier (VNI) on HUAWEI CloudEngine switches.

Arguments: vpn_target_export, state, route_distinguisher, vpn_target_both, evpn, vpn_target_import, bridge_domain_id

Manages Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations on HUAWEI CloudEngine switches.

Ce Evpn Bgp *arguments

Manages BGP EVPN configuration on HUAWEI CloudEngine switches.

Arguments: as_number, advertise_l2vpn_evpn, advertise_router_type, vpn_name, peer_group_name, state, bgp_instance, peer_enable, peer_address

This module offers the ability to configure a BGP EVPN peer relationship on HUAWEI CloudEngine switches.

Ce Evpn Bgp Rr *arguments

Manages RR for the VXLAN Network on HUAWEI CloudEngine switches.

Arguments: as_number, bgp_instance, reflect_client, peer, bgp_evpn_enable, policy_vpn_target, peer_type

Configure an RR in BGP-EVPN address family view on HUAWEI CloudEngine switches.

Ce Evpn Global *arguments

Manages global configuration of EVPN on HUAWEI CloudEngine switches.

Arguments: evpn_overlay_enable

Manages global configuration of EVPN on HUAWEI CloudEngine switches.

Ce Facts *arguments

Gets facts about HUAWEI CloudEngine switches.

Arguments: gather_subset

Collects facts from CloudEngine devices running the CloudEngine operating system. Fact collection is supported over Cli transport. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Ce File Copy *arguments

Copy a file to a remote cloudengine device over SCP on HUAWEI CloudEngine switches.

Arguments: local_file, remote_file, file_system

Copy a file to a remote cloudengine device over SCP on HUAWEI CloudEngine switches.

Ce Info Center Debug *arguments

Manages information center debug configuration on HUAWEI CloudEngine switches.

Arguments: debug_enable, state, debug_level, channel_id, module_name, debug_time_stamp

Manages information center debug configurations on HUAWEI CloudEngine switches.

Ce Info Center Global *arguments

Manages outputting logs on HUAWEI CloudEngine switches.

Arguments: server_ip, filter_log_name, facility, ssl_policy_name, transport_mode, channel_cfg_name, suppress_enable, channel_out_direct, channel_id, filter_feature_name, is_default_vpn, server_domain, level, packet_priority, source_ip, channel_name, state, vrf_name, logfile_max_size, server_port, timestamp, info_center_enable, ip_type, logfile_max_num

This module offers the ability to be output to the log buffer, log file, console, terminal, or log host on HUAWEI CloudEngine switches.

Ce Info Center Log *arguments

Manages information center log configuration on HUAWEI CloudEngine switches.

Arguments: log_level, log_enable, log_buff_size, channel_id, state, log_buff_enable, log_time_stamp, module_name

Setting the Timestamp Format of Logs. Configuring the Device to Output Logs to the Log Buffer.

Ce Info Center Trap *arguments

Manages information center trap configuration on HUAWEI CloudEngine switches.

Arguments: trap_time_stamp, trap_buff_size, channel_id, state, trap_level, trap_buff_enable, module_name, trap_enable

Manages information center trap configurations on HUAWEI CloudEngine switches.

Ce Interface *arguments

Manages physical attributes of interfaces on HUAWEI CloudEngine switches.

Arguments: state, admin_state, description, interface, interface_type, mode, l2sub

Manages physical attributes of interfaces on HUAWEI CloudEngine switches.

Ce Interface Ospf *arguments

Manages configuration of an OSPF interface instanceon HUAWEI CloudEngine switches.

Arguments: cost, area, silent_interface, auth_mode, auth_key_id, dead_interval, auth_text_simple, state, process_id, hello_interval, auth_text_md5, interface

Manages configuration of an OSPF interface instanceon HUAWEI CloudEngine switches.

Ce Ip Interface *arguments

Manages L3 attributes for IPv4 and IPv6 interfaces on HUAWEI CloudEngine switches.

Arguments: state, version, addr, interface, mask, ipv4_type

Manages Layer 3 attributes for IPv4 and IPv6 interfaces on HUAWEI CloudEngine switches.

Ce Link Status *arguments

Get interface link status on HUAWEI CloudEngine switches.

Arguments: interface

Get interface link status on HUAWEI CloudEngine switches.

Ce Mlag Config *arguments

Manages MLAG configuration on HUAWEI CloudEngine switches.

Arguments: eth_trunk_id, pseudo_priority, ip_address, priority_id, vpn_instance_name, peer_link_id, state, dfs_group_id, nickname, pseudo_nickname

Manages MLAG configuration on HUAWEI CloudEngine switches.

Ce Mlag Interface *arguments

Manages MLAG interfaces on HUAWEI CloudEngine switches.

Arguments: eth_trunk_id, mlag_id, mlag_error_down, mlag_system_id, state, dfs_group_id, interface, mlag_priority_id

Manages MLAG interface attributes on HUAWEI CloudEngine switches.

Ce Mtu *arguments

Manages MTU settings on HUAWEI CloudEngine switches.

Arguments: interface, state, jumbo_max, jumbo_min, mtu

Manages MTU settings on HUAWEI CloudEngine switches.

Ce Netconf *arguments

Run an arbitrary netconf command on HUAWEI CloudEngine switches.

Arguments: rpc, cfg_xml

Sends an arbitrary netconf command on HUAWEI CloudEngine switches.

Ce Netstream Aging *arguments

Manages timeout mode of NetStream on HUAWEI CloudEngine switches.

Arguments: timeout_type, state, type, manual_slot, timeout_interval

Manages timeout mode of NetStream on HUAWEI CloudEngine switches.

Ce Netstream Export *arguments

Manages netstream export on HUAWEI CloudEngine switches.

Arguments: bgp_nexthop, host_port, source_ip, host_ip, as_option, state, version, type, host_vpn

Configure NetStream flow statistics exporting and versions for exported packets on HUAWEI CloudEngine switches.

Ce Netstream Global *arguments

Manages global parameters of NetStream on HUAWEI CloudEngine switches.

Arguments: statistics_direction, index_switch, state, sampler_interval, statistics_record, sampler_direction, interface, type

Manages global parameters of NetStream on HUAWEI CloudEngine switches.

Ce Netstream Template *arguments

Manages NetStream template configuration on HUAWEI CloudEngine switches.

Arguments: state, collect_interface, record_name, description, type, collect_counter, match

Manages NetStream template configuration on HUAWEI CloudEngine switches.

Ce Ntp *arguments

Manages core NTP configuration on HUAWEI CloudEngine switches.

Arguments: state, is_preferred, peer, key_id, vpn_name, server, source_int

Manages core NTP configuration on HUAWEI CloudEngine switches.

Ce Ntp Auth *arguments

Manages NTP authentication configuration on HUAWEI CloudEngine switches.

Arguments: auth_type, state, auth_pwd, key_id, trusted_key, auth_mode, authentication

Manages NTP authentication configuration on HUAWEI CloudEngine switches.

Ce Ospf *arguments

Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.

Arguments: addr, area, max_load_balance, mask, auth_mode, auth_key_id, auth_text_simple, state, process_id, nexthop_addr, auth_text_md5, nexthop_weight

Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.

Ce Ospf Vrf *arguments

Manages configuration of an OSPF VPN instance on HUAWEI CloudEngine switches.

Arguments: description, lsaostartinterval, lsaastartinterval, lsaointerval, bandwidth, spfintervalmi, spfinterval, lsaointervalflag, lsaomaxinterval, lsaalflag, lsaamaxinterval, lsaoholdinterval, spfintervaltype, lsaainterval, spfstartinterval, route_id, state, spfmaxinterval, spfholdinterval, lsaaholdinterval, ospf, vrf

Manages configuration of an OSPF VPN instance on HUAWEI CloudEngine switches.

Ce Reboot *arguments

Reboot a HUAWEI CloudEngine switches.

Arguments: save_config, confirm

Reboot a HUAWEI CloudEngine switches.

Ce Rollback *arguments

Set a checkpoint or rollback to a checkpoint on HUAWEI CloudEngine switches.

Arguments: commit_id, oldest, last, action, filename, label

This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on HUAWEI CloudEngine switches.

Ce Sflow *arguments

Manages sFlow configuration on HUAWEI CloudEngine switches.

Arguments: agent_ip, export_route, counter_collector, rate_limit_slot, source_ip, collector_datagram_size, sample_collector, rate_limit, sample_direction, collector_meth, collector_ip_vpn, forward_enp_slot, collector_ip, sflow_interface, sample_length, state, collector_id, sample_rate, collector_udp_port, counter_interval, collector_description

Configure Sampled Flow (sFlow) to monitor traffic on an interface in real time, detect abnormal traffic, and locate the source of attack traffic, ensuring stable running of the network.

Ce Snmp Community *arguments

Manages SNMP community configuration on HUAWEI CloudEngine switches.

Arguments: notify_view, community_name, community_mib_view, read_view, acl_number, group_name, write_view, state, security_level, access_right

Manages SNMP community configuration on HUAWEI CloudEngine switches.

Ce Snmp Contact *arguments

Manages SNMP contact configuration on HUAWEI CloudEngine switches.

Arguments: state, contact

Manages SNMP contact configurations on HUAWEI CloudEngine switches.

Ce Snmp Location *arguments

Manages SNMP location configuration on HUAWEI CloudEngine switches.

Arguments: state, location

Manages SNMP location configurations on HUAWEI CloudEngine switches.

Ce Snmp Target Host *arguments

Manages SNMP target host configuration on HUAWEI CloudEngine switches.

Arguments: security_name_v3, recv_port, security_model, vpn_name, address, security_name, notify_type, connect_port, version, host_name, security_level, interface_name, is_public_net

Manages SNMP target host configurations on HUAWEI CloudEngine switches.

Ce Snmp Traps *arguments

Manages SNMP traps configuration on HUAWEI CloudEngine switches.

Arguments: feature_name, interface_type, trap_name, port_number, interface_number

Manages SNMP traps configurations on HUAWEI CloudEngine switches.

Ce Snmp User *arguments

Manages SNMP user configuration on HUAWEI CloudEngine switches.

Arguments: priv_key, aaa_local_user, auth_key, usm_user_name, acl_number, auth_protocol, remote_engine_id, priv_protocol, user_group

Manages SNMP user configurations on CloudEngine switches.

Ce Startup *arguments

Manages a system startup information on HUAWEI CloudEngine switches.

Arguments: slot, action, cfg_file, patch_file, software_file

Manages a system startup information on HUAWEI CloudEngine switches.

Ce Static Route *arguments

Manages static route configuration on HUAWEI CloudEngine switches.

Arguments: prefix, aftype, description, pref, mask, destvrf, nhp_interface, state, next_hop, vrf, tag

Manages the static routes on HUAWEI CloudEngine switches.

Ce Stp *arguments

Manages STP configuration on HUAWEI CloudEngine switches.

Arguments: loop_protection, tc_protection_threshold, bpdu_filter, stp_converge, stp_mode, bpdu_protection, root_protection, state, cost, stp_enable, interface, tc_protection, edged_port, tc_protection_interval

Manages STP configurations on HUAWEI CloudEngine switches.

Ce Switchport *arguments

Manages Layer 2 switchport interfaces on HUAWEI CloudEngine switches.

Arguments: pvid_vlan, tagged_vlans, default_vlan, trunk_vlans, state, untagged_vlans, mode, interface

Manages Layer 2 switchport interfaces on HUAWEI CloudEngine switches.

Ce Vlan *arguments

Manages VLAN resources and attributes on Huawei CloudEngine switches.

Arguments: state, vlan_range, name, vlan_id, description

Manages VLAN configurations on Huawei CloudEngine switches.

Ce Vrf *arguments

Manages VPN instance on HUAWEI CloudEngine switches.

Arguments: state, vrf, description

Manages VPN instance of HUAWEI CloudEngine switches.

Ce Vrf Af *arguments

Manages VPN instance address family on HUAWEI CloudEngine switches.

Arguments: vpn_target_type, vpn_target_state, vrf_aftype, state, route_distinguisher, vrf, evpn, vpn_target_value

Manages VPN instance address family of HUAWEI CloudEngine switches.

Ce Vrf Interface *arguments

Manages interface specific VPN configuration on HUAWEI CloudEngine switches.

Arguments: state, vrf, vpn_interface

Manages interface specific VPN configuration of HUAWEI CloudEngine switches.

Ce Vrrp *arguments

Manages VRRP interfaces on HUAWEI CloudEngine devices.

Arguments: vrrp_type, auth_mode, is_plain, interface, preempt_timer_delay, gratuitous_arp_interval, auth_key, vrid, priority, recover_delay, state, version, virtual_ip, admin_interface, admin_ignore_if_down, fast_resume, admin_flowdown, holding_multiplier, admin_vrid, advertise_interval

Manages VRRP interface attributes on HUAWEI CloudEngine devices.

Ce Vxlan Arp *arguments

Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices.

Arguments: evn_bgp, vbdif_name, bridge_domain_id, state, evn_server, evn_peer_ip, evn_source_ip, arp_collect_host, arp_suppress, evn_reflect_client, host_collect_protocol

Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices.

Ce Vxlan Gateway *arguments

Manages gateway for the VXLAN network on HUAWEI CloudEngine devices.

Arguments: dfs_source_vpn, dfs_id, arp_direct_route, dfs_peer_vpn, vbdif_name, vpn_vni, vbdif_mac, vbdif_bind_vpn, dfs_source_ip, dfs_udp_port, arp_distribute_gateway, state, dfs_all_active, vpn_instance, dfs_peer_ip

Configuring Centralized All-Active Gateways or Distributed Gateway for the VXLAN Network on HUAWEI CloudEngine devices.

Ce Vxlan Global *arguments

Manages global attributes of VXLAN and bridge domain on HUAWEI CloudEngine devices.

Arguments: nvo3_prevent_loops, nvo3_eth_trunk_hash, tunnel_mode_vxlan, nvo3_acl_extend, bridge_domain_id, nvo3_gw_enhanced, state, nvo3_ecmp_hash, nvo3_service_extend

Manages global attributes of VXLAN and bridge domain on HUAWEI CloudEngine devices.

Ce Vxlan Tunnel *arguments

Manages VXLAN tunnel configuration on HUAWEI CloudEngine devices.

Arguments: vni_id, nve_mode, source_ip, bridge_domain_id, peer_list_ip, state, nve_name, protocol_type

This module offers the ability to set the VNI and mapped to the BD, and configure an ingress replication list on HUAWEI CloudEngine devices.

Ce Vxlan Vap *arguments

Manages VXLAN virtual access point on HUAWEI CloudEngine Devices.

Arguments: state, pe_vid, l2_sub_interface, ce_vid, encapsulation, bind_vlan_id, bridge_domain_id

Manages VXLAN Virtual access point on HUAWEI CloudEngine Devices.

Certificate Complete Chain *arguments

Complete certificate chain given a set of untrusted and root certificates

Arguments: root_certificates, intermediate_certificates, input_chain

This module completes a given chain of certificates in PEM format by finding intermediate certificates from a given set of certificates, until it finds a root certificate in another given set of certificates. This can for example be used to find the root certificate for a certificate chain returned by M(acme_certificate). Note that this module does I(not) check for validity of the chains. It only checks that issuer and subject match, and that the signature is correct. It ignores validity dates and key usage completely. If you need to verify that a generated chain is valid, please use C(openssl verify ...).

Checkpoint Access Layer Facts *arguments

Get access layer facts on Check Point over Web Services API

Arguments: uid, name

Get access layer facts on Check Point devices. All operations are performed over Web Services API.

Checkpoint Access Rule *arguments

Manages access rules on Check Point over Web Services API

Arguments: layer, name, source, destination, enabled, auto_install_policy, state, auto_publish_session, position, action, policy_package, targets

Manages access rules on Check Point devices including creating, updating, removing access rules objects, All operations are performed over Web Services API.

Checkpoint Access Rule Facts *arguments

Get access rules objects facts on Check Point over Web Services API

Arguments: layer, name, uid

Get access rules objects facts on Check Point devices. All operations are performed over Web Services API.

Checkpoint Host *arguments

Manages host objects on Check Point over Web Services API

Arguments: auto_install_policy, state, auto_publish_session, name, policy_package, ip_address, targets

Manages host objects on Check Point devices including creating, updating, removing access rules objects. All operations are performed over Web Services API.

Checkpoint Host Facts *arguments

Get host objects facts on Check Point over Web Services API

Arguments: name, uid

Get host objects facts on Check Point devices. All operations are performed over Web Services API.

Checkpoint Object Facts *arguments

Get object facts on Check Point over Web Services API

Arguments: object_type, ip_only, object_filter, uid

Get object facts on Check Point devices. All operations are performed over Web Services API.

Checkpoint Run Script *arguments

Run scripts on Check Point devices over Web Services API

Arguments: targets, script_name, script

Run scripts on Check Point devices. All operations are performed over Web Services API.

Checkpoint Session *arguments

Manages session objects on Check Point over Web Services API

Arguments: state, uid

Manages session objects on Check Point devices performing actions like publish and discard. All operations are performed over Web Services API.

Checkpoint Task Facts *arguments

Get task objects facts on Check Point over Web Services API

Arguments: task_id

Get task objects facts on Check Point devices. All operations are performed over Web Services API.

Circonus Annotation *arguments

create an annotation in circonus

Arguments: category, start, description, title, duration, api_key, stop

Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided

Cisco Spark *arguments

Send a message to a Cisco Spark Room or Individual.

Arguments: personal_token, message, recipient_id, message_type, recipient_type

Send a message to a Cisco Spark Room or Individual with options to control the formatting.

Clc Aa Policy *arguments

Create or Delete Anti Affinity Policies at CenturyLink Cloud.

Arguments: state, location, name, wait

An Ansible module to Create or Delete Anti Affinity Policies at CenturyLink Cloud.

Clc Alert Policy *arguments

Create or Delete Alert Policies at CenturyLink Cloud.

Arguments: name, metric, alert_recipients, alias, state, threshold, id, duration

An Ansible module to Create or Delete Alert Policies at CenturyLink Cloud.

Clc Blueprint Package *arguments

deploys a blue print package on a set of servers in CenturyLink Cloud.

Arguments: server_ids, package_id, package_params, state, wait

An Ansible module to deploy blue print package on a set of servers in CenturyLink Cloud.

Clc Firewall Policy *arguments

Create/delete/update firewall policies

Arguments: destination_account_alias, destination, enabled, location, source, state, firewall_policy_id, source_account_alias, ports, wait

Create or delete or update firewall policies on Centurylink Cloud

Clc Group *arguments

Create/delete Server Groups at Centurylink Cloud

Arguments: state, name, parent, wait, location, description

Create or delete Server Groups at Centurylink Centurylink Cloud

Clc Loadbalancer *arguments

Create, Delete shared loadbalancers in CenturyLink Cloud.

Arguments: status, name, method, alias, state, location, nodes, port, persistence, description

An Ansible module to Create, Delete shared loadbalancers in CenturyLink Cloud.

Clc Modify Server *arguments

modify servers in CenturyLink Cloud.

Arguments: alert_policy_id, anti_affinity_policy_name, state, anti_affinity_policy_id, alert_policy_name, memory, server_ids, cpu, wait

An Ansible module to modify servers in CenturyLink Cloud.

Clc Publicip *arguments

Add and Delete public ips on servers in CenturyLink Cloud.

Arguments: server_ids, state, protocol, ports, wait

An Ansible module to add or delete public ip addresses on an existing server or servers in CenturyLink Cloud.

Clc Server *arguments

Create, Delete, Start and Stop servers in CenturyLink Cloud.

Arguments: cpu_autoscale_policy_id, anti_affinity_policy_name, storage_type, anti_affinity_policy_id, ttl, count_group, secondary_dns, custom_fields, packages, group, exact_count, state, location, template, memory, server_ids, type, managed_os, additional_disks, description, add_public_ip, alert_policy_id, alert_policy_name, password, ip_address, public_ip_protocol, wait, count, name, network_id, primary_dns, alias, public_ip_ports, source_server_password, os_type, configuration_id, cpu

An Ansible module to Create, Delete, Start and Stop servers in CenturyLink Cloud.

Clc Server Snapshot *arguments

Create, Delete and Restore server snapshots in CenturyLink Cloud.

Arguments: server_ids, expiration_days, state, wait

An Ansible module to Create, Delete and Restore server snapshots in CenturyLink Cloud.

Cli Command *arguments

Run a cli command on cli-based network devices

Arguments: sendonly, prompt, check_all, answer, command, newline

Sends a command to a network device and returns the result read from the device.

Cli Config *arguments

Push text based configuration to network devices over network_cli

Arguments: multiline_delimiter, backup_options, rollback, commit_comment, diff_replace, replace, defaults, commit, diff_match, config, backup, diff_ignore_lines

This module provides platform agnostic way of pushing text based configuration to network devices over network_cli connection plugin.

Cloud Init Data Facts *arguments

Retrieve facts of cloud-init.

Arguments: filter

Gathers facts by reading the status.json and result.json of cloud-init.

Cloudflare Dns *arguments

Manage Cloudflare DNS records

Arguments: solo, account_email, weight, proxied, hash_type, selector, ttl, port, account_api_token, service, algorithm, proto, value, priority, record, state, timeout, key_tag, cert_usage, zone, type

Manages dns records via the Cloudflare API, see the docs: U(https://api.cloudflare.com/)

Cloudformation *arguments

Create or delete an AWS CloudFormation stack

Arguments: template_body, disable_rollback, notification_arns, backoff_max_delay, template_format, stack_name, termination_protection, template_url, template_parameters, role_arn, backoff_retries, stack_policy, tags, capabilities, events_limit, state, template, on_create_failure, create_timeout, changeset_name, create_changeset, backoff_delay

Launches or updates an AWS CloudFormation stack and waits for it complete.

Cloudformation Info *arguments

Obtain information about an AWS CloudFormation stack

Arguments: stack_events, all_facts, stack_resources, stack_template, stack_name, stack_policy

Gets information about an AWS CloudFormation stack This module was called C(cloudformation_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(cloudformation_info) module no longer returns C(ansible_facts)!

Cloudformation Stack Set *arguments

Manage groups of CloudFormation stacks

Arguments: template_body, description, tags, wait_timeout, template_url, administration_role_arn, wait, failure_tolerance, name, parameters, state, capabilities, regions, execution_role_name, template, purge_stacks, accounts

Launches/updates/deletes AWS CloudFormation Stack Sets

Cloudfront Distribution *arguments

create, update and delete aws cloudfront distributions.

Arguments: comment, purge_custom_error_responses, e_tag, tags, purge_tags, caller_reference, default_root_object, alias, wait_timeout, purge_aliases, default_origin_domain_name, ipv6_enabled, purge_cache_behaviors, aliases, restrictions, logging, http_version, origins, web_acl_id, viewer_certificate, price_class, purge_origins, default_cache_behavior, distribution_id, state, cache_behaviors, custom_error_responses, default_origin_path, wait, enabled

Allows for easy creation, updating and deletion of CloudFront distributions.

Cloudfront Info *arguments

Obtain facts about an AWS CloudFront distribution

Arguments: list_streaming_distributions, origin_access_identity_config, invalidation, domain_name_alias, list_invalidations, origin_access_identity_id, list_distributions_by_web_acl_id, origin_access_identity, streaming_distribution_config, all_lists, list_distributions, summary, web_acl_id, streaming_distribution, distribution_id, distribution_config, invalidation_id, distribution, list_origin_access_identities

Gets information about an AWS CloudFront distribution This module was called C(cloudfront_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(cloudfront_info) module no longer returns C(ansible_facts)!

Cloudfront Invalidation *arguments

create invalidations for aws cloudfront distributions

Arguments: distribution_id, alias, target_paths, caller_reference

Allows for invalidation of a batch of paths for a CloudFront distribution.

Cloudfront Origin Access Identity *arguments

create, update and delete origin access identities for a cloudfront distribution.

Arguments: comment, state, origin_access_identity_id, caller_reference

Allows for easy creation, updating and deletion of origin access identities.

Cloudscale Floating Ip *arguments

Manages floating IPs on the cloudscale.ch IaaS service

Arguments: state, reverse_ptr, prefix_length, ip_version, ip, server

Create, assign and delete floating IPs on the cloudscale.ch IaaS service.

Cloudscale Server *arguments

Manages servers on the cloudscale.ch IaaS service

Arguments: server_groups, force, use_public_network, tags, image, api_timeout, user_data, anti_affinity_with, use_private_network, flavor, password, ssh_keys, uuid, name, state, volume_size_gb, bulk_volume_size_gb, use_ipv6

Create, update, start, stop and delete servers on the cloudscale.ch IaaS service.

Cloudscale Server Group *arguments

Manages server groups on the cloudscale.ch IaaS service

Arguments: uuid, state, type, name, tags

Create, update and remove server groups.

Cloudscale Volume *arguments

Manages volumes on the cloudscale.ch IaaS service.

Arguments: size_gb, name, tags, server_uuids, type, state, uuid

Create, attach/detach, update and delete volumes on the cloudscale.ch IaaS service.

Cloudtrail *arguments

manage CloudTrail create, delete, update

Arguments: enable_log_file_validation, include_global_events, name, is_multi_region_trail, kms_key_id, cloudwatch_logs_log_group_arn, s3_bucket_name, cloudwatch_logs_role_arn, state, sns_topic_name, s3_key_prefix, enable_logging, tags

Creates, deletes, or updates CloudTrail configuration. Ensures logging is also enabled.

Cloudwatchevent Rule *arguments

Manage CloudWatch Event rules and targets

Arguments: state, role_arn, description, name, targets, event_pattern, schedule_expression

This module creates and manages CloudWatch event rules and targets.

Cloudwatchlogs Log Group *arguments

create or delete log_group in CloudWatchLogs

Arguments: state, log_group_name, tags, kms_key_id, overwrite, retention

Create or delete log_group in CloudWatchLogs.

Cloudwatchlogs Log Group Info *arguments

get information about log_group in CloudWatchLogs

Arguments: log_group_name

Lists the specified log groups. You can list all your log groups or filter the results by prefix. This module was called C(cloudwatchlogs_log_group_facts) before Ansible 2.9. The usage did not change.

Cnos Backup *arguments

Backup the current running or startup configuration to a remote server on devices running Lenovo CNOS

Arguments: serverpassword, configType, protocol, serverusername, rcserverip, rcpath

This module allows you to work with switch configurations. It provides a way to back up the running or startup configurations of a switch to a remote server. This is achieved by periodically saving a copy of the startup or running configuration of the network device to a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the location where the configuration will be backed up. Authentication details required by the remote server must be provided as well. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos Banner *arguments

Manage multiline banners on Lenovo CNOS devices

Arguments: text, state, banner, provider

This will configure both login and motd banners on remote devices running Lenovo CNOS. It allows playbooks to add or remote banner text from the active running configuration.

Cnos Bgp *arguments

Manage BGP resources and attributes on devices running CNOS

Arguments: bgpArg8, asNum, bgpArg4, bgpArg5, bgpArg6, bgpArg7, bgpArg1, bgpArg2, bgpArg3

This module allows you to work with Border Gateway Protocol (BGP) related configurations. The operators used are overloaded to ensure control over switch BGP configurations. This module is invoked using method with asNumber as one of its arguments. The first level of the BGP configuration allows to set up an AS number, with the following attributes going into various configuration operations under the context of BGP. After passing this level, there are eight BGP arguments that will perform further configurations. They are bgpArg1, bgpArg2, bgpArg3, bgpArg4, bgpArg5, bgpArg6, bgpArg7, and bgpArg8. For more details on how to use these arguments, see [Overloaded Variables]. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos Command *arguments

Run arbitrary commands on Lenovo CNOS devices

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an CNOS node and returns the results read from the device. The C(cnos_command) module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Cnos Conditional Command *arguments

Execute a single command based on condition on devices running Lenovo CNOS

Arguments: flag, clicommand, condition

This module allows you to modify the running configuration of a switch. It provides a way to execute a single CNOS command on a network device by evaluating the current running configuration and executing the command only if the specific settings have not been already configured. The CNOS command is passed as an argument of the method. This module functions the same as the cnos_command module. The only exception is that following inventory variable can be specified ["condition = <flag string>"] When this inventory variable is specified as the variable of a task, the command is executed for the network element that matches the flag string. Usually, commands are executed across a group of network devices. When there is a requirement to skip the execution of the command on one or more devices, it is recommended to use this module. This module uses SSH to manage network device configuration.

Cnos Conditional Template *arguments

Manage switch configuration using templates based on condition on devices running Lenovo CNOS

Arguments: flag, commandfile, condition

This module allows you to work with the running configuration of a switch. It provides a way to execute a set of CNOS commands on a switch by evaluating the current running configuration and executing the commands only if the specific settings have not been already configured. The configuration source can be a set of commands or a template written in the Jinja2 templating language. This module functions the same as the cnos_template module. The only exception is that the following inventory variable can be specified. ["condition = <flag string>"] When this inventory variable is specified as the variable of a task, the template is executed for the network element that matches the flag string. Usually, templates are used when commands are the same across a group of network devices. When there is a requirement to skip the execution of the template on one or more devices, it is recommended to use this module. This module uses SSH to manage network device configuration.

Cnos Config *arguments

Manage Lenovo CNOS configuration sections

Arguments: comment, src, backup_options, admin, config, after, lines, replace, parents, backup, match, before

Lenovo CNOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with CNOS configuration sections in a deterministic way.

Cnos Factory *arguments

Reset the switch startup configuration to default (factory) on devices running Lenovo CNOS.

Arguments:

This module allows you to reset a switch's startup configuration. The method provides a way to reset the startup configuration to its factory settings. This is helpful when you want to move the switch to another topology as a new network device. This module uses SSH to manage network device configuration. The result of the operation can be viewed in results directory.

Cnos Facts *arguments

Collect facts from remote devices running Lenovo CNOS

Arguments: authorize, auth_pass, gather_subset

Collects a base set of device facts from a remote Lenovo device running on CNOS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Cnos Image *arguments

Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS

Arguments: serverpassword, protocol, serverusername, imgtype, serverip, imgpath

This module allows you to work with switch firmware images. It provides a way to download a firmware image to a network device from a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the image's location. Authentication details required by the remote server must be provided as well. By default, this method makes the newly downloaded firmware image the active image, which will be used by the switch during the next restart. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos Interface *arguments

Manage Interface on Lenovo CNOS network devices

Arguments: neighbors, rx_rate, name, duplex, enabled, mtu, delay, state, provider, aggregate, speed, tx_rate, description

This module provides declarative management of Interfaces on Lenovo CNOS network devices.

Cnos L2 Interface *arguments

Manage Layer-2 interface on Lenovo CNOS devices.

Arguments: native_vlan, access_vlan, name, trunk_vlans, state, trunk_allowed_vlans, mode, provider, aggregate

This module provides declarative management of Layer-2 interfaces on Lenovo CNOS devices.

Cnos L3 Interface *arguments

Manage Layer-3 interfaces on Lenovo CNOS network devices.

Arguments: state, name, ipv6, aggregate, provider, ipv4

This module provides declarative management of Layer-3 interfaces on CNOS network devices.

Cnos Linkagg *arguments

Manage link aggregation groups on Lenovo CNOS devices

Arguments: purge, state, group, mode, members, provider, aggregate

This module provides declarative management of link aggregation groups on Lenovo CNOS network devices.

Cnos Lldp *arguments

Manage LLDP configuration on Lenovo CNOS network devices.

Arguments: state

This module provides declarative management of LLDP service on Lenovc CNOS network devices.

Cnos Logging *arguments

Manage logging on network devices

Arguments: aggregate, state, name, level, dest, facility, size

This module provides declarative management of logging on Cisco Cnos devices.

Cnos Reload *arguments

Perform switch restart on devices running Lenovo CNOS

Arguments:

This module allows you to restart the switch using the current startup configuration. The module is usually invoked after the running configuration has been saved over the startup configuration. This module uses SSH to manage network device configuration. The results of the operation can be viewed in results directory.

Cnos Rollback *arguments

Roll back the running or startup configuration from a remote server on devices running Lenovo CNOS

Arguments: serverpassword, configType, protocol, serverusername, rcserverip, rcpath

This module allows you to work with switch configurations. It provides a way to roll back configurations of a switch from a remote server. This is achieved by using startup or running configurations of the target device that were previously backed up to a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of he backup configuration's location. Authentication details required by the remote server must be provided as well. By default, this method overwrites the switch's configuration file with the newly downloaded file. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos Save *arguments

Save the running configuration as the startup configuration on devices running Lenovo CNOS

Arguments:

This module allows you to copy the running configuration of a switch over its startup configuration. It is recommended to use this module shortly after any major configuration changes so they persist after a switch restart. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos Showrun *arguments

Collect the current running configuration on devices running on CNOS

Arguments:

This module allows you to view the switch running configuration. It executes the display running-config CLI command on a switch and returns a file containing the current running configuration of the target network device. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos Static Route *arguments

Manage static IP routes on Lenovo CNOS network devices

Arguments: description, mask, prefix, admin_distance, interface, state, next_hop, aggregate, tag

This module provides declarative management of static IP routes on Lenovo CNOS network devices.

Cnos System *arguments

Manage the system attributes on Lenovo CNOS devices

Arguments: state, lookup_source, name_servers, domain_search, hostname, domain_name, lookup_enabled

This module provides declarative management of node system attributes on Lenovo CNOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Cnos Template *arguments

Manage switch configuration using templates on devices running Lenovo CNOS

Arguments: commandfile

This module allows you to work with the running configuration of a switch. It provides a way to execute a set of CNOS commands on a switch by evaluating the current running configuration and executing the commands only if the specific settings have not been already configured. The configuration source can be a set of commands or a template written in the Jinja2 templating language. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos User *arguments

Manage the collection of local users on Lenovo CNOS devices

Arguments: update_password, configured_password, name, purge, state, role, aggregate, sshkey

This module provides declarative management of the local usernames configured on Lenovo CNOS devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Cnos Vlag *arguments

Manage VLAG resources and attributes on devices running Lenovo CNOS

Arguments: vlagArg2, vlagArg3, vlagArg1, vlagArg4

This module allows you to work with virtual Link Aggregation Groups (vLAG) related configurations. The operators used are overloaded to ensure control over switch vLAG configurations. Apart from the regular device connection related attributes, there are four vLAG arguments which are overloaded variables that will perform further configurations. They are vlagArg1, vlagArg2, vlagArg3, and vlagArg4. For more details on how to use these arguments, see [Overloaded Variables]. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run.

Cnos Vlan *arguments

Manage VLANs on CNOS network devices

Arguments: delay, name, interfaces, purge, associated_interfaces, state, provider, aggregate, vlan_id

This module provides declarative management of VLANs on Lenovo CNOS network devices.

Cnos Vrf *arguments

Manage VRFs on Lenovo CNOS network devices

Arguments: rd, name, interfaces, purge, associated_interfaces, state, delay, aggregate

This module provides declarative management of VRFs on Lenovo CNOS network devices.

Cobbler Sync *arguments

Sync Cobbler

Arguments: username, host, use_ssl, password, validate_certs, port

Sync Cobbler to commit changes.

Cobbler System *arguments

Manage system objects in Cobbler

Arguments: username, name, interfaces, sync, port, state, host, use_ssl, password, validate_certs, properties

Add, modify or remove systems in Cobbler

Command *arguments

Execute commands on targets

Arguments: creates, chdir, strip_empty_ends, cmd, removes, argv, warn, free_form, stdin_add_newline, stdin

The C(command) module takes the command name followed by a list of space-delimited arguments. The given command will be executed on all selected nodes. The command(s) will not be processed through the shell, so variables like C($HOME) and operations like C("<"), C(">"), C("|"), C(";") and C("&") will not work. Use the M(shell) module if you need these features. To create C(command) tasks that are easier to read than the ones using space-delimited arguments, pass parameters using the C(args) L(task keyword,../reference_appendices/playbooks_keywords.html#task) or use C(cmd) parameter. Either a free form command or C(cmd) parameter is required, see the examples. For Windows targets, use the M(win_command) module instead.

Composer *arguments

Dependency Manager for PHP

Arguments: executable, prefer_source, no_scripts, apcu_autoloader, prefer_dist, working_dir, global_command, command, arguments, classmap_authoritative, ignore_platform_reqs, no_dev, no_plugins, optimize_autoloader

Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you.

Consul *arguments

Add, modify & delete services within a consul cluster.

Arguments: service_address, http, tags, check_name, service_name, host, ttl, port, script, check_id, service_port, notes, interval, token, state, timeout, service_id, scheme, validate_certs

Registers services and checks for an agent with a consul cluster. A service is some process running on the agent node that should be advertised by consul's discovery mechanism. It may optionally supply a check definition, a periodic service test to notify the consul cluster of service's health. Checks may also be registered per node e.g. disk usage, or cpu usage and notify the health of the entire node to the cluster. Service level checks do not require a check name or id as these are derived by Consul from the Service name and id respectively by appending 'service:' Node level checks require a I(check_name) and optionally a I(check_id). Currently, there is no complete way to retrieve the script, interval or ttl metadata for a registered check. Without this metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result this does not attempt to determine changes and will always report a changed occurred. An API method is planned to supply this metadata so at that stage change management will be added. See U(http://consul.io) for more details.

Consul Acl *arguments

Manipulate Consul ACL keys and rules

Arguments: name, rules, state, token_type, token, mgmt_token, host, scheme, validate_certs, port

Allows the addition, modification and deletion of ACL keys and associated rules in a consul cluster via the agent. For more details on using and configuring ACLs, see https://www.consul.io/docs/guides/acl.html.

Consul Kv *arguments

Manipulate entries in the key/value store of a consul cluster

Arguments: retrieve, cas, recurse, state, value, token, session, flags, key, host, scheme, validate_certs, port

Allows the retrieval, addition, modification and deletion of key/value entries in a consul cluster via the agent. The entire contents of the record, including the indices, flags and session are returned as C(value). If the C(key) represents a prefix then note that when a value is removed, the existing value if any is returned as part of the results. See http://www.consul.io/docs/agent/http.html#kv for more details.

Consul Session *arguments

Manipulate consul sessions

Arguments: node, datacenter, name, state, checks, delay, host, behavior, id, scheme, validate_certs, port

Allows the addition, modification and deletion of sessions in a consul cluster. These sessions can then be used in conjunction with key value pairs to implement distributed locks. In depth documentation for working with sessions can be found at http://www.consul.io/docs/internals/sessions.html

Copy *arguments

Copy files to remote locations

Arguments: src, directory_mode, force, remote_src, dest, checksum, content, mode, follow, backup, local_follow

The C(copy) module copies a file from the local or remote machine to a location on the remote machine. Use the M(fetch) module to copy files from remote locations to the local box. If you need variable interpolation in copied files, use the M(template) module. Using a variable in the C(content) field will result in unpredictable output. For Windows targets, use the M(win_copy) module instead.

Cp Mgmt Access Layer *arguments

Manages access-layer objects on Check Point over Web Services API

Arguments: applications_and_url_filtering, content_awareness, name, tags, firewall, ignore_warnings, implicit_cleanup_action, detect_using_x_forward_for, color, mobile_access, details_level, comments, shared, ignore_errors, add_default_rule

Manages access-layer objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Access Layer Facts *arguments

Get access-layer objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get access-layer objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Access Role *arguments

Manages access-role objects on Check Point over Web Services API

Arguments: users, tags, color, ignore_warnings, comments, details_level, ignore_errors, remote_access_clients, networks, machines, name

Manages access-role objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Access Role Facts *arguments

Get access-role objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get access-role objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Access Rule *arguments

Manages access-rule objects on Check Point over Web Services API

Arguments: layer, install_on, track, service_negate, position, ignore_errors, vpn, custom_fields, inline_layer, content_direction, destination_negate, name, service, destination, enabled, ignore_warnings, comments, content, source, details_level, source_negate, content_negate, time, action, action_settings, user_check

Manages access-rule objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Access Rule Facts *arguments

Get access-rule objects facts on Check Point over Web Services API

Arguments: filter_settings, layer, name, package, show_hits, use_object_dictionary, order, filter, hits_settings, details_level, show_as_ranges, offset, limit, show_membership, dereference_group_members

Get access-rule objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Address Range *arguments

Manages address-range objects on Check Point over Web Services API

Arguments: nat_settings, name, ipv4_address_last, tags, color, ipv6_address_first, ignore_warnings, comments, ip_address_first, ip_address_last, ipv6_address_last, groups, ignore_errors, details_level, ipv4_address_first

Manages address-range objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Address Range Facts *arguments

Get address-range objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get address-range objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Administrator *arguments

Manages administrator objects on Check Point over Web Services API

Arguments: phone_number, tacacs_server, tags, color, authentication_method, permissions_profile, radius_server, ignore_errors, password, password_hash, name, expiration_date, multi_domain_profile, ignore_warnings, comments, must_change_password, details_level, email

Manages administrator objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Administrator Facts *arguments

Get administrator objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get administrator objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Application Site *arguments

Manages application-site objects on Check Point over Web Services API

Arguments: description, tags, application_signature, url_list, ignore_warnings, comments, name, color, details_level, groups, additional_categories, ignore_errors, primary_category, urls_defined_as_regular_expression

Manages application-site objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Application Site Category *arguments

Manages application-site-category objects on Check Point over Web Services API

Arguments: name, tags, color, ignore_warnings, comments, details_level, groups, ignore_errors, description

Manages application-site-category objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Application Site Category Facts *arguments

Get application-site-category objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get application-site-category objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Application Site Facts *arguments

Get application-site objects facts on Check Point over Web Services API

Arguments: application_id, name, offset, details_level, limit, show_membership, order

Get application-site objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Application Site Group *arguments

Manages application-site-group objects on Check Point over Web Services API

Arguments: name, tags, color, ignore_warnings, comments, members, details_level, groups, ignore_errors

Manages application-site-group objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Application Site Group Facts *arguments

Get application-site-group objects facts on Check Point over Web Services API

Arguments: limit, name, dereference_group_members, offset, details_level, show_membership, order

Get application-site-group objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Assign Global Assignment *arguments

assign global assignment on Check Point over Web Services API

Arguments: global_domains, dependent_domains, details_level

assign global assignment on Check Point over Web Services API All operations are performed over Web Services API.

Cp Mgmt Discard *arguments

All changes done by user are discarded and removed from database.

Arguments: uid

All changes done by user are discarded and removed from database. All operations are performed over Web Services API.

Cp Mgmt Dns Domain *arguments

Manages dns-domain objects on Check Point over Web Services API

Arguments: name, tags, color, is_sub_domain, ignore_warnings, comments, details_level, ignore_errors

Manages dns-domain objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Dns Domain Facts *arguments

Get dns-domain objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get dns-domain objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Dynamic Object *arguments

Manages dynamic-object objects on Check Point over Web Services API

Arguments: details_level, name, tags, color, ignore_errors, ignore_warnings, comments

Manages dynamic-object objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Dynamic Object Facts *arguments

Get dynamic-object objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get dynamic-object objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Exception Group *arguments

Manages exception-group objects on Check Point over Web Services API

Arguments: name, applied_threat_rules, tags, color, apply_on, ignore_warnings, comments, details_level, ignore_errors, applied_profile

Manages exception-group objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Exception Group Facts *arguments

Get exception-group objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get exception-group objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Global Assignment *arguments

Manages global-assignment objects on Check Point over Web Services API

Arguments: manage_protection_actions, ignore_warnings, dependent_domain, global_domain, details_level, global_threat_prevention_policy, ignore_errors, global_access_policy

Manages global-assignment objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Global Assignment Facts *arguments

Get global-assignment objects facts on Check Point over Web Services API

Arguments: dependent_domain, global_domain, details_level, offset, limit, order

Get global-assignment objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Group *arguments

Manages group objects on Check Point over Web Services API

Arguments: name, tags, color, ignore_warnings, comments, members, details_level, groups, ignore_errors

Manages group objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Group Facts *arguments

Get group objects facts on Check Point over Web Services API

Arguments: name, order, limit, show_as_ranges, offset, details_level, show_membership, dereference_group_members

Get group objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Group With Exclusion *arguments

Manages group-with-exclusion objects on Check Point over Web Services API

Arguments: name, tags, color, except, comments, ignore_warnings, details_level, groups, ignore_errors, include

Manages group-with-exclusion objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Group With Exclusion Facts *arguments

Get group-with-exclusion objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_as_ranges

Get group-with-exclusion objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Host *arguments

Manages host objects on Check Point over Web Services API

Arguments: ipv6_address, nat_settings, name, tags, color, interfaces, ignore_warnings, comments, ipv4_address, host_servers, details_level, groups, ignore_errors, ip_address

Manages host objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Host Facts *arguments

Get host objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get host objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Install Policy *arguments

install policy on Check Point over Web Services API

Arguments: qos, threat_prevention, prepare_only, desktop_security, targets, access, policy_package, install_on_all_cluster_members_or_fail, revision

install policy on Check Point over Web Services API All operations are performed over Web Services API.

Cp Mgmt Mds Facts *arguments

Get Multi-Domain Server (mds) objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get mds objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Multicast Address Range *arguments

Manages multicast-address-range objects on Check Point over Web Services API

Arguments: ipv6_address, ipv4_address_first, ipv4_address_last, tags, color, ipv4_address, ip_address_first, groups, ignore_errors, ip_address, name, ipv6_address_first, ignore_warnings, comments, ip_address_last, ipv6_address_last, details_level

Manages multicast-address-range objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Multicast Address Range Facts *arguments

Get multicast-address-range objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get multicast-address-range objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Network *arguments

Manages network objects on Check Point over Web Services API

Arguments: subnet6, subnet4, tags, color, broadcast, subnet_mask, groups, ignore_errors, mask_length, subnet, nat_settings, name, ignore_warnings, comments, details_level, mask_length4, mask_length6

Manages network objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Network Facts *arguments

Get network objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get network objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Package *arguments

Manages package objects on Check Point over Web Services API

Arguments: qos, access_layers, tags, color, vpn_traditional_mode, qos_policy_type, ignore_errors, installation_targets, access, name, threat_prevention, desktop_security, ignore_warnings, comments, threat_layers, details_level

Manages package objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Package Facts *arguments

Get package objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get package objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Publish *arguments

All the changes done by this user will be seen by all users only after publish is called.

Arguments: uid

All the changes done by this user will be seen by all users only after publish is called. All operations are performed over Web Services API.

Cp Mgmt Put File *arguments

put file on Check Point over Web Services API

Arguments: file_content, file_name, targets, comments, file_path

put file on Check Point over Web Services API All operations are performed over Web Services API.

Cp Mgmt Run Ips Update *arguments

Runs IPS database update. If "package-path" is not provided server will try to get the latest package from the User Center.

Arguments: package_path

Runs IPS database update. If "package-path" is not provided server will try to get the latest package from the User Center. All operations are performed over Web Services API.

Cp Mgmt Run Script *arguments

Executes the script on a given list of targets.

Arguments: script_name, args, targets, comments, script

Executes the script on a given list of targets. All operations are performed over Web Services API.

Cp Mgmt Security Zone *arguments

Manages security-zone objects on Check Point over Web Services API

Arguments: details_level, name, tags, color, ignore_errors, ignore_warnings, comments

Manages security-zone objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Security Zone Facts *arguments

Get security-zone objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get security-zone objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Dce Rpc *arguments

Manages service-dce-rpc objects on Check Point over Web Services API

Arguments: name, tags, color, ignore_warnings, comments, details_level, groups, ignore_errors, interface_uuid, keep_connections_open_after_policy_installation

Manages service-dce-rpc objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Dce Rpc Facts *arguments

Get service-dce-rpc objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-dce-rpc objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Group *arguments

Manages service-group objects on Check Point over Web Services API

Arguments: name, tags, color, ignore_warnings, comments, members, details_level, groups, ignore_errors

Manages service-group objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Group Facts *arguments

Get service-group objects facts on Check Point over Web Services API

Arguments: name, order, limit, show_as_ranges, offset, details_level, show_membership, dereference_group_members

Get service-group objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Icmp *arguments

Manages service-icmp objects on Check Point over Web Services API

Arguments: icmp_code, name, tags, color, ignore_warnings, comments, details_level, groups, ignore_errors, icmp_type, keep_connections_open_after_policy_installation

Manages service-icmp objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Icmp Facts *arguments

Get service-icmp objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-icmp objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Icmp6 *arguments

Manages service-icmp6 objects on Check Point over Web Services API

Arguments: icmp_code, name, tags, color, ignore_warnings, comments, details_level, groups, ignore_errors, icmp_type, keep_connections_open_after_policy_installation

Manages service-icmp6 objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Icmp6 Facts *arguments

Get service-icmp6 objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-icmp6 objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Other *arguments

Manages service-other objects on Check Point over Web Services API

Arguments: ip_protocol, tags, color, ignore_warnings, match_for_any, groups, use_default_session_timeout, ignore_errors, accept_replies, name, override_default_settings, sync_connections_on_cluster, comments, session_timeout, details_level, action, keep_connections_open_after_policy_installation, aggressive_aging, match

Manages service-other objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Other Facts *arguments

Get service-other objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-other objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Rpc *arguments

Manages service-rpc objects on Check Point over Web Services API

Arguments: program_number, name, tags, color, ignore_warnings, comments, details_level, groups, ignore_errors, keep_connections_open_after_policy_installation

Manages service-rpc objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Rpc Facts *arguments

Get service-rpc objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-rpc objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Sctp *arguments

Manages service-sctp objects on Check Point over Web Services API

Arguments: tags, color, ignore_warnings, match_for_any, groups, use_default_session_timeout, ignore_errors, port, name, sync_connections_on_cluster, comments, session_timeout, details_level, source_port, keep_connections_open_after_policy_installation, aggressive_aging

Manages service-sctp objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Sctp Facts *arguments

Get service-sctp objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-sctp objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Tcp *arguments

Manages service-tcp objects on Check Point over Web Services API

Arguments: protocol, tags, color, ignore_warnings, match_for_any, groups, use_default_session_timeout, ignore_errors, port, name, override_default_settings, match_by_protocol_signature, sync_connections_on_cluster, comments, session_timeout, details_level, source_port, keep_connections_open_after_policy_installation, aggressive_aging

Manages service-tcp objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Tcp Facts *arguments

Get service-tcp objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-tcp objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Service Udp *arguments

Manages service-udp objects on Check Point over Web Services API

Arguments: protocol, tags, color, ignore_warnings, match_for_any, groups, use_default_session_timeout, ignore_errors, accept_replies, port, name, override_default_settings, match_by_protocol_signature, sync_connections_on_cluster, comments, session_timeout, details_level, source_port, keep_connections_open_after_policy_installation, aggressive_aging

Manages service-udp objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Service Udp Facts *arguments

Get service-udp objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get service-udp objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Session Facts *arguments

Get session objects facts on Check Point over Web Services API

Arguments: limit, view_published_sessions, details_level, order, offset

Get session objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Simple Gateway *arguments

Manages simple-gateway objects on Check Point over Web Services API

Arguments: ipv6_address, firewall, one_time_password, ips, logs_settings, firewall_settings, send_logs_to_server, save_logs_locally, ignore_warnings, comments, url_filtering, version, threat_extraction, vpn_settings, threat_emulation, content_awareness, os_name, tags, interfaces, application_control, ipv4_address, send_alerts_to_server, groups, ignore_errors, anti_bot, vpn, ip_address, color, send_logs_to_backup_server, name, anti_virus, details_level

Manages simple-gateway objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Simple Gateway Facts *arguments

Get simple-gateway objects facts on Check Point over Web Services API

Arguments: limit, name, offset, details_level, order, show_membership

Get simple-gateway objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Tag *arguments

Manages tag objects on Check Point over Web Services API

Arguments: details_level, name, tags, color, ignore_errors, ignore_warnings, comments

Manages tag objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Tag Facts *arguments

Get tag objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get tag objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Threat Exception *arguments

Manages threat-exception objects on Check Point over Web Services API

Arguments: layer, install_on, track, protected_scope, protected_scope_negate, service_negate, protection_or_site, exception_group_name, ignore_errors, destination_negate, name, service, rule_name, destination, enabled, ignore_warnings, comments, source, details_level, source_negate, exception_group_uid, action, position

Manages threat-exception objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Threat Exception Facts *arguments

Get threat-exception objects facts on Check Point over Web Services API

Arguments: filter_settings, layer, name, package, exception_group_uid, use_object_dictionary, order, filter, rule_name, exception_group_name, details_level, offset, limit, show_membership, dereference_group_members

Get threat-exception objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Threat Indicator *arguments

Manages threat-indicator objects on Check Point over Web Services API

Arguments: name, tags, color, ignore_warnings, comments, observables_raw_data, details_level, observables, action, ignore_errors, profile_overrides

Manages threat-indicator objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Threat Indicator Facts *arguments

Get threat-indicator objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get threat-indicator objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Threat Layer *arguments

Manages threat-layer objects on Check Point over Web Services API

Arguments: name, tags, color, ignore_warnings, comments, details_level, ignore_errors, add_default_rule

Manages threat-layer objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Threat Layer Facts *arguments

Get threat-layer objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get threat-layer objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Threat Profile *arguments

Manages threat-profile objects on Check Point over Web Services API

Arguments: active_protections_severity, tags, color, ips_settings, activate_protections_by_extended_attributes, use_indicators, ips, indicator_overrides, confidence_level_high, ignore_errors, anti_bot, anti_virus, confidence_level_low, name, deactivate_protections_by_extended_attributes, overrides, ignore_warnings, comments, confidence_level_medium, active_protections_performance_impact, malicious_mail_policy_settings, use_extended_attributes, details_level, threat_emulation

Manages threat-profile objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Threat Profile Facts *arguments

Get threat-profile objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get threat-profile objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Threat Protection Override *arguments

Edit existing object using object name or uid.

Arguments: follow_up, overrides, details_level, name, comments

Edit existing object using object name or uid. All operations are performed over Web Services API.

Cp Mgmt Threat Rule *arguments

Manages threat-rule objects on Check Point over Web Services API

Arguments: layer, install_on, track, enabled, protected_scope_negate, service_negate, ignore_errors, destination_negate, name, service, destination, protected_scope, ignore_warnings, comments, source, details_level, source_negate, track_settings, action, position

Manages threat-rule objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Threat Rule Facts *arguments

Get threat-rule objects facts on Check Point over Web Services API

Arguments: filter_settings, layer, name, package, use_object_dictionary, order, filter, limit, offset, details_level, show_membership, dereference_group_members

Get threat-rule objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Time *arguments

Manages time objects on Check Point over Web Services API

Arguments: end_never, end, name, tags, color, ignore_warnings, comments, recurrence, start, details_level, groups, ignore_errors, hours_ranges, start_now

Manages time objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Time Facts *arguments

Get time objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get time objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Verify Policy *arguments

Verifies the policy of the selected package.

Arguments: policy_package

Verifies the policy of the selected package. All operations are performed over Web Services API.

Cp Mgmt Vpn Community Meshed *arguments

Manages vpn-community-meshed objects on Check Point over Web Services API

Arguments: ike_phase_2, ike_phase_1, name, tags, color, ignore_warnings, comments, shared_secrets, encryption_method, gateways, ignore_errors, encryption_suite, details_level, use_shared_secret

Manages vpn-community-meshed objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Vpn Community Meshed Facts *arguments

Get vpn-community-meshed objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get vpn-community-meshed objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Vpn Community Star *arguments

Manages vpn-community-star objects on Check Point over Web Services API

Arguments: ike_phase_2, ike_phase_1, satellite_gateways, tags, color, ignore_warnings, center_gateways, ignore_errors, name, mesh_center_gateways, comments, shared_secrets, encryption_method, details_level, encryption_suite, use_shared_secret

Manages vpn-community-star objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Vpn Community Star Facts *arguments

Get vpn-community-star objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get vpn-community-star objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Mgmt Wildcard *arguments

Manages wildcard objects on Check Point over Web Services API

Arguments: ipv6_address, name, tags, color, ipv6_mask_wildcard, comments, ignore_warnings, ipv4_address, details_level, groups, ignore_errors, ipv4_mask_wildcard

Manages wildcard objects on Check Point devices including creating, updating and removing objects. All operations are performed over Web Services API.

Cp Mgmt Wildcard Facts *arguments

Get wildcard objects facts on Check Point over Web Services API

Arguments: details_level, offset, limit, order, name

Get wildcard objects facts on Check Point devices. All operations are performed over Web Services API. This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter 'name'.

Cp Publish *arguments

All the changes done by this user will be seen by all users only after publish is called.

Arguments: uid

All the changes done by this user will be seen by all users only after publish is called. All operations are performed over Web Services API.

Cpanm *arguments

Manages Perl library dependencies.

Arguments: executable, name, installdeps, system_lib, mirror_only, from_path, version, mirror, locallib, notest

Manage Perl library dependencies.

Cpm Plugconfig *arguments

Get and Set Plug Parameters on WTI OOB and PDU power devices

Arguments: plug_default, use_proxy, cpm_password, cpm_url, plug_name, plug_bootdelay, plug_id, cpm_action, plug_bootpriority, cpm_username, validate_certs, use_https

Get and Set Plug Parameters on WTI OOB and PDU devices

Cpm Plugcontrol *arguments

Get and Set Plug actions on WTI OOB and PDU power devices

Arguments: use_proxy, cpm_password, cpm_url, plug_id, plug_state, cpm_action, cpm_username, validate_certs, use_https

Get and Set Plug actions on WTI OOB and PDU devices

Cpm Serial Port Config *arguments

Set Serial port parameters in WTI OOB and PDU devices

Arguments: baud, parity, seq, cpm_url, echo, stopbits, break_allow, port, use_https, handshake, use_proxy, cpm_password, cmd, logoff, tout, mode, portname, cpm_username, validate_certs

Set Serial port parameters in WTI OOB and PDU devices

Cpm Serial Port Info *arguments

Get Serial port parameters in WTI OOB and PDU devices

Arguments: use_proxy, cpm_password, cpm_url, cpm_username, validate_certs, port, use_https

Get Serial port parameters from WTI OOB and PDU devices

Cpm User *arguments

Get various status and parameters from WTI OOB and PDU devices

Arguments: user_accessweb, cpm_url, user_accessserial, user_portaccess, user_plugaccess, user_groupaccess, user_callbackphone, use_https, user_accessoutbound, user_accessapi, use_proxy, cpm_password, validate_certs, user_accessssh, user_accessmonitor, user_accesslevel, cpm_action, user_pass, cpm_username, user_name

Get/Add/Edit Delete Users from WTI OOB and PDU devices

Cron *arguments

Manage cron.d and crontab entries

Arguments: cron_file, month, disabled, job, special_time, user, insertafter, insertbefore, day, minute, name, hour, reboot, state, weekday, env, backup

Use this module to manage crontab and environment variables entries. This module allows you to create environment variables and named crontab entries, update, or delete them. When crontab jobs are managed: the module includes one line with the description of the crontab entry C("#Ansible: <name>") corresponding to the "name" passed to the module, which is used by future ansible/module calls to find/check the state. The "name" parameter should be unique, and changing the "name" value will result in a new cron task being created (or a different one being removed). When environment variables are managed, no comment line is added, but, when the module needs to find/check the state, it uses the "name" parameter to find the environment variable definition line. When using symbols such as %, they must be properly escaped.

Cronvar *arguments

Manage variables in crontabs

Arguments: name, insertbefore, cron_file, value, state, user, insertafter, backup

Use this module to manage crontab variables. This module allows you to create, update, or delete cron variable definitions.

Crypttab *arguments

Encrypted Linux block devices

Arguments: state, name, backing_device, path, password, opts

Control Linux encrypted block devices that are set up during system boot in C(/etc/crypttab).

Cs Account *arguments

Manages accounts on Apache CloudStack based clouds.

Arguments: username, first_name, last_name, account_type, name, password, domain, timezone, state, role, ldap_domain, poll_async, network_domain, email, ldap_type

Create, disable, lock, enable and remove accounts.

Cs Affinitygroup *arguments

Manages affinity groups on Apache CloudStack based clouds.

Arguments: account, poll_async, name, domain, affinity_type, project, state, description

Create and remove affinity groups.

Cs Cluster *arguments

Manages host clusters on Apache CloudStack based clouds.

Arguments: username, guest_vswitch_type, ovm3_cluster, ovm3_pool, pod, hypervisor, guest_vswitch_name, vms_username, password, public_vswitch_type, name, zone, url, cluster_type, ovm3_vip, vms_ip_address, state, public_vswitch_name, vms_password

Create, update and remove clusters.

Cs Configuration *arguments

Manages configuration on Apache CloudStack based clouds.

Arguments: cluster, domain, name, zone, storage, account, value

Manages global, zone, account, storage and cluster configurations.

Cs Disk Offering *arguments

Manages disk offerings on Apache CloudStack based clouds.

Arguments: domain, storage_tags, storage_type, name, display_text, disk_size, iops_read_rate, iops_min, iops_max, bytes_read_rate, customized, iops_write_rate, state, provisioning_type, display_offering, hypervisor_snapshot_reserve, bytes_write_rate

Create and delete disk offerings for guest VMs. Update display_text or display_offering of existing disk offering.

Cs Domain *arguments

Manages domains on Apache CloudStack based clouds.

Arguments: path, state, network_domain, poll_async, clean_up

Create, update and remove domains.

Cs Facts *arguments

Gather facts on instances of Apache CloudStack based clouds.

Arguments: filter, meta_data_host

This module fetches data from the metadata API in CloudStack. The module must be called from within the instance itself.

Cs Firewall *arguments

Manages firewall rules on Apache CloudStack based clouds.

Arguments: icmp_code, domain, protocol, tags, end_port, start_port, icmp_type, ip_address, account, poll_async, network, zone, cidrs, project, state, type

Creates and removes firewall rules.

Cs Host *arguments

Manages hosts on Apache CloudStack based clouds.

Arguments: username, name, zone, host_tags, url, hypervisor, cluster, state, pod, password, allocation_state

Create, update and remove hosts.

Cs Image Store *arguments

Manages CloudStack Image Stores.

Arguments: force_recreate, state, name, zone, provider, url

Deploy, remove, recreate CloudStack Image Stores.

Cs Instance *arguments

Manages instances and virtual machines on Apache CloudStack based clouds.

Arguments: domain, force, disk_offering, allow_root_disk_shrink, keyboard, user_data, root_disk_size, cpu_speed, ip6_address, networks, security_groups, group, zone, state, details, template, memory, iso, template_filter, tags, ssh_key, host, display_name, service_offering, ip_address, account, disk_size, name, hypervisor, ip_to_networks, project, affinity_groups, poll_async, cpu

Deploy, start, update, scale, restart, restore, stop and destroy instances.

Cs Instance Info *arguments

Gathering information from the API of instances from Apache CloudStack based clouds.

Arguments: project, account, domain, name

Gathering information from the API of an instance.

Cs Instance Nic *arguments

Manages NICs of an instance on Apache CloudStack based clouds.

Arguments: account, poll_async, network, zone, domain, vm, project, state, vpc, ip_address

Add and remove nic to and from network

Cs Instance Nic Secondaryip *arguments

Manages secondary IPs of an instance on Apache CloudStack based clouds.

Arguments: vm_guest_ip, account, poll_async, network, zone, domain, vm, project, state, vpc

Add and remove secondary IPs to and from a NIC of an instance.

Cs Instance Password Reset *arguments

Allows resetting VM the default passwords on Apache CloudStack based clouds.

Arguments: project, account, poll_async, zone, domain, vm

Resets the default user account's password on an instance. Requires cloud-init to be installed in the virtual machine. The passwordenabled flag must be set on the template associated with the VM.

Cs Instancegroup *arguments

Manages instance groups on Apache CloudStack based clouds.

Arguments: project, account, state, domain, name

Create and remove instance groups.

Cs Ip Address *arguments

Manages public IP address associations on Apache CloudStack based clouds.

Arguments: account, poll_async, network, zone, tags, domain, project, state, vpc, ip_address

Acquires and associates a public IP to an account or project. Due to API limitations this is not an idempotent call, so be sure to only conditionally call this when I(state=present). Tagging the IP address can also make the call idempotent.

Cs Iso *arguments

Manages ISO images on Apache CloudStack based clouds.

Arguments: is_featured, tags, iso_filter, domain, is_public, display_text, account, poll_async, name, zone, url, checksum, is_dynamically_scalable, cross_zones, project, bootable, state, is_ready, os_type

Register and remove ISO images.

Cs Loadbalancer Rule *arguments

Manages load balancer rules on Apache CloudStack based clouds.

Arguments: domain, protocol, description, tags, private_port, vpc, cidr, ip_address, network, account, poll_async, name, algorithm, open_firewall, public_port, project, state, zone

Add, update and remove load balancer rules.

Cs Loadbalancer Rule Member *arguments

Manages load balancer rule members on Apache CloudStack based clouds.

Arguments: domain, poll_async, name, zone, account, project, state, ip_address, vms

Add and remove load balancer rule members.

Cs Network *arguments

Manages networks on Apache CloudStack based clouds.

Arguments: domain, end_ipv6, tags, vlan, clean_up, netmask, network_offering, vpc, start_ip, acl, gateway, gateway_ipv6, display_text, isolated_pvlan, account, subdomain_access, poll_async, name, zone, acl_type, start_ipv6, cidr_ipv6, project, state, end_ip, network_domain

Create, update, restart and delete networks.

Cs Network Acl *arguments

Manages network access control lists (ACL) on Apache CloudStack based clouds.

Arguments: account, poll_async, name, zone, domain, project, state, vpc, description

Create and remove network ACLs.

Cs Network Acl Rule *arguments

Manages network access control list (ACL) rules on Apache CloudStack based clouds.

Arguments: icmp_code, domain, protocol, vpc, tags, end_port, network_acl, action_policy, start_port, icmp_type, account, poll_async, zone, protocol_number, cidrs, rule_position, project, state, traffic_type

Add, update and remove network ACL rules.

Cs Network Offering *arguments

Manages network offerings on Apache CloudStack based clouds.

Arguments: keepalive_enabled, specify_vlan, egress_default_policy, specify_ip_ranges, service_capabilities, service_offering, supported_services, conserve_mode, availability, guest_ip_type, max_connections, display_text, for_vpc, service_providers, name, persistent, state, details, network_rate, traffic_type

Create, update, enable, disable and remove network offerings.

Cs Physical Network *arguments

Manages physical networks on Apache CloudStack based clouds.

Arguments: domain, nsps_disabled, name, zone, tags, isolation_method, vlan, nsps_enabled, network_speed, broadcast_domain_range, state, poll_async

Create, update and remove networks. Enabled and disabled Network Service Providers Enables Internal LoadBalancer and VPC/VirtualRouter elements as required

Cs Pod *arguments

Manages pods on Apache CloudStack based clouds.

Arguments: name, zone, netmask, gateway, state, end_ip, start_ip, id

Create, update, delete pods.

Cs Portforward *arguments

Manages port forwarding rules on Apache CloudStack based clouds.

Arguments: vm_guest_ip, domain, protocol, tags, vm, private_port, vpc, private_end_port, ip_address, account, poll_async, network, open_firewall, public_port, public_end_port, project, state, zone

Create, update and remove port forwarding rules.

Cs Project *arguments

Manages projects on Apache CloudStack based clouds.

Arguments: display_text, account, state, poll_async, name, tags, domain

Create, update, suspend, activate and remove projects.

Cs Region *arguments

Manages regions on Apache CloudStack based clouds.

Arguments: state, endpoint, id, name

Add, update and remove regions.

Cs Resourcelimit *arguments

Manages resource limits on Apache CloudStack based clouds.

Arguments: project, domain, limit, account, resource_type

Manage limits of resources for domains, accounts and projects.

Cs Role *arguments

Manages user roles on Apache CloudStack based clouds.

Arguments: id, state, description, role_type, name

Create, update, delete user roles.

Cs Role Permission *arguments

Manages role permissions on Apache CloudStack based clouds.

Arguments: state, role, description, parent, permission, name

Create, update and remove CloudStack role permissions. Managing role permissions only supported in CloudStack >= 4.9.

Cs Router *arguments

Manages routers on Apache CloudStack based clouds.

Arguments: account, poll_async, name, zone, domain, project, state, service_offering

Start, restart, stop and destroy routers. I(state=present) is not able to create routers, use M(cs_network) instead.

Cs Securitygroup *arguments

Manages security groups on Apache CloudStack based clouds.

Arguments: project, account, name, state, domain, description

Create and remove security groups.

Cs Securitygroup Rule *arguments

Manages security group rules on Apache CloudStack based clouds.

Arguments: icmp_code, protocol, start_port, user_security_group, end_port, project, state, security_group, poll_async, cidr, icmp_type, type

Add and remove security group rules.

Cs Service Offering *arguments

Manages service offerings on Apache CloudStack based clouds.

Arguments: offer_ha, cpu_number, domain, disk_bytes_read_rate, system_vm_type, limit_cpu_usage, memory, is_system, storage_tags, storage_type, is_volatile, network_rate, cpu_speed, service_offering_details, disk_iops_max, disk_iops_read_rate, display_text, is_customized, name, is_iops_customized, host_tags, deployment_planner, state, disk_iops_min, disk_iops_write_rate, provisioning_type, hypervisor_snapshot_reserve, disk_bytes_write_rate

Create and delete service offerings for guest and system VMs. Update display_text of existing service offering.

Cs Snapshot Policy *arguments

Manages volume snapshot policies on Apache CloudStack based clouds.

Arguments: volume, domain, schedule, interval_type, vm, volume_type, time_zone, project, state, vpc, account, max_snaps, device_id

Create, update and delete volume snapshot policies.

Cs Sshkeypair *arguments

Manages SSH keys on Apache CloudStack based clouds.

Arguments: project, public_key, account, name, state, domain

Create, register and remove SSH keys. If no key was found and no public key was provided and a new SSH private/public key pair will be created and the private key will be returned.

Cs Staticnat *arguments

Manages static NATs on Apache CloudStack based clouds.

Arguments: vm_guest_ip, domain, poll_async, network, zone, vm, project, state, vpc, account, ip_address

Create, update and remove static NATs.

Cs Storage Pool *arguments

Manages Primary Storage Pools on Apache CloudStack based clouds.

Arguments: managed, name, zone, cluster, hypervisor, storage_tags, capacity_iops, state, capacity_bytes, provider, scope, pod, allocation_state, storage_url

Create, update, put into maintenance, disable, enable and remove storage pools.

Cs Template *arguments

Manages templates on Apache CloudStack based clouds.

Arguments: is_featured, format, vm, domain, is_extractable, checksum, poll_async, password_enabled, zone, sshkey_enabled, is_dynamically_scalable, state, is_ready, details, template_find_options, is_routing, template_tag, template_filter, tags, is_public, requires_hvm, display_text, account, name, url, bits, cross_zones, project, snapshot, mode, hypervisor, os_type

Register templates from an URL. Create templates from a ROOT volume of a stopped VM or its snapshot. Update (since version 2.7), extract and delete templates.

Cs Traffic Type *arguments

Manages traffic types on CloudStack Physical Networks

Arguments: poll_async, zone, hyperv_networklabel, vlan, vmware_networklabel, isolation_method, state, physical_network, xen_networklabel, traffic_type, kvm_networklabel, ovm3_networklabel

Add, remove, update Traffic Types associated with CloudStack Physical Networks.

Cs User *arguments

Manages users on Apache CloudStack based clouds.

Arguments: username, keys_registered, account, last_name, poll_async, first_name, state, domain, timezone, password, email

Create, update, disable, lock, enable and remove users.

Cs Vlan Ip Range *arguments

Manages VLAN IP ranges on Apache CloudStack based clouds.

Arguments: domain, end_ipv6, vlan, netmask, for_virtual_network, start_ip, gateway, gateway_ipv6, account, network, zone, start_ipv6, cidr_ipv6, project, state, end_ip, physical_network

Create and delete VLAN IP range.

Cs Vmsnapshot *arguments

Manages VM snapshots on Apache CloudStack based clouds.

Arguments: snapshot_memory, domain, poll_async, description, zone, tags, vm, project, state, account, name

Create, remove and revert VM from snapshots.

Cs Volume *arguments

Manages volumes on Apache CloudStack based clouds.

Arguments: custom_id, domain, force, disk_offering, tags, shrink_ok, vm, display_volume, min_iops, size, account, poll_async, name, zone, url, format, state, project, max_iops, snapshot, mode, device_id

Create, destroy, attach, detach, extract or upload volumes.

Cs Vpc *arguments

Manages VPCs on Apache CloudStack based clouds.

Arguments: display_text, vpc_offering, poll_async, name, zone, tags, clean_up, project, state, domain, account, cidr, network_domain

Create, update and delete VPCs.

Cs Vpc Offering *arguments

Manages vpc offerings on Apache CloudStack based clouds.

Arguments: display_text, service_providers, poll_async, name, state, supported_services, service_capabilities, service_offering

Create, update, enable, disable and remove CloudStack VPC offerings.

Cs Vpn Connection *arguments

Manages site-to-site VPN connections on Apache CloudStack based clouds.

Arguments: vpn_customer_gateway, passive, domain, force, zone, account, project, state, vpc, poll_async

Create and remove VPN connections.

Cs Vpn Customer Gateway *arguments

Manages site-to-site VPN customer gateway configurations on Apache CloudStack based clouds.

Arguments: domain, poll_async, name, ipsec_psk, esp_lifetime, esp_policy, cidrs, account, gateway, project, state, dpd, ike_policy, force_encap, ike_lifetime

Create, update and remove VPN customer gateways.

Cs Vpn Gateway *arguments

Manages site-to-site VPN gateways on Apache CloudStack based clouds.

Arguments: project, account, poll_async, vpc, zone, state, domain

Creates and removes VPN site-to-site gateways.

Cs Zone *arguments

Manages zones on Apache CloudStack based clouds.

Arguments: domain, dhcp_provider, dns2_ipv6, id, securitygroups_enabled, dns1_ipv6, internal_dns1, internal_dns2, name, dns2, dns1, state, guest_cidr_address, network_domain, local_storage_enabled, network_type

Create, update and remove zones.

Cs Zone Info *arguments

Gathering information about zones from Apache CloudStack based clouds.

Arguments: zone

Gathering information from the API of a zone.

Cv Server Provision *arguments

Provision server port by applying or removing template configuration to an Arista CloudVision Portal configlet that is applied to a switch.

Arguments: username, port_vlan, protocol, switch_port, server_name, port, host, template, auto_run, action, password, switch_name

This module allows a server team to provision server network ports for new servers without having to access Arista CVP or asking the network team to do it for them. Provide the information for connecting to CVP, switch rack, port the new server is connected to, optional vlan, and an action and the module will apply the configuration to the switch port via CVP. Actions are add (applies template config to port), remove (defaults the interface config) and show (returns the current port config).

Cyberark Authentication *arguments

Module for CyberArk Vault Authentication using PAS Web Services SDK

Arguments: username, use_radius_authentication, new_password, cyberark_session, state, password, validate_certs, use_shared_logon_authentication, api_base_url

Authenticates to CyberArk Vault using Privileged Account Security Web Services SDK and creates a session fact that can be used by other modules. It returns an Ansible fact called I(cyberark_session). Every module can use this fact as C(cyberark_session) parameter.

Cyberark User *arguments

Module for CyberArk User Management using PAS Web Services SDK

Arguments: username, first_name, last_name, initial_password, user_type_name, new_password, cyberark_session, group_name, disabled, change_password_on_the_next_logon, state, expiry_date, location, email

CyberArk User Management using PAS Web Services SDK. It currently supports the following actions Get User Details, Add User, Update User, Delete User.

Data Pipeline *arguments

Create and manage AWS Datapipelines

Arguments: name, parameters, tags, state, objects, values, timeout, description

Create and manage AWS Datapipelines. Creation is not idempotent in AWS, so the I(uniqueId) is created by hashing the options (minus objects) given to the datapipeline. The pipeline definition must be in the format given here U(https://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html#API_PutPipelineDefinition_RequestSyntax). Also operations will wait for a configurable amount of time to ensure the pipeline is in the requested state.

Datadog Event *arguments

Posts events to Datadog service

Arguments: date_happened, alert_type, title, text, tags, app_key, priority, host, aggregation_key, api_key, validate_certs

Allows to post events to Datadog (www.datadoghq.com) service. Uses http://docs.datadoghq.com/api/#events API.

Datadog Monitor *arguments

Manages Datadog monitors

Arguments: notify_audit, timeout_h, tags, thresholds, new_host_delay, app_key, evaluation_delay, query, message, id, locked, name, no_data_timeframe, silenced, require_full_window, notify_no_data, renotify_interval, state, escalation_message, api_key, type

Manages monitors within Datadog. Options as described on https://docs.datadoghq.com/api/.

Dconf *arguments

Modify and read dconf database

Arguments: state, key, value

This module allows modifications and reading of dconf database. The module is implemented as a wrapper around dconf tool. Please see the dconf(1) man page for more details. Since C(dconf) requires a running D-Bus session to change values, the module will try to detect an existing session and reuse it, or run the tool via C(dbus-run-session).

Debconf *arguments

Configure a .deb package

Arguments: value, vtype, question, name, unseen

Configure a .deb package using debconf-set-selections. Or just query existing selections.

Debug *arguments

Print statements during execution

Arguments: msg, var, verbosity

This module prints statements during execution and can be useful for debugging variables or expressions without necessarily halting the playbook. Useful for debugging together with the 'when:' directive. This module is also supported for Windows targets.

Dellos10 Command *arguments

Run commands on remote devices running Dell OS10

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to a Dell EMC OS10 node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(dellos10_config) to configure Dell EMC OS10 devices.

Dellos10 Config *arguments

Manage Dell EMC Networking OS10 configuration sections

Arguments: src, backup_options, config, after, lines, update, replace, parents, save, backup, match, before

OS10 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS10 configuration sections in a deterministic way.

Dellos10 Facts *arguments

Collect facts from remote devices running Dell EMC Networking OS10

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running OS10. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Dellos6 Command *arguments

Run commands on remote devices running Dell OS6

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to a Dell OS6 node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(dellos6_config) to configure Dell OS6 devices.

Dellos6 Config *arguments

Manage Dell EMC Networking OS6 configuration sections

Arguments: src, backup_options, config, after, lines, update, replace, parents, save, backup, match, before

OS6 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS6 configuration sections in a deterministic way.

Dellos6 Facts *arguments

Collect facts from remote devices running Dell EMC Networking OS6

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running OS6. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Dellos9 Command *arguments

Run commands on remote devices running Dell OS9

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to a Dell OS9 node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(dellos9_config) to configure Dell OS9 devices.

Dellos9 Config *arguments

Manage Dell EMC Networking OS9 configuration sections

Arguments: src, backup_options, config, after, lines, update, replace, parents, save, backup, match, before

OS9 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS9 configuration sections in a deterministic way.

Dellos9 Facts *arguments

Collect facts from remote devices running Dell EMC Networking OS9

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running OS9. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Deploy Helper *arguments

Manages some of the steps common in deploying projects.

Arguments: unfinished_filename, keep_releases, current_path, state, shared_path, releases_path, clean, release, path

The Deploy Helper manages some of the steps common in deploying software. It creates a folder structure, manages a symlink for the current release and cleans up old releases. Running it with the C(state=query) or C(state=present) will return the C(deploy_helper) fact. C(project_path), whatever you set in the path parameter, C(current_path), the path to the symlink that points to the active release, C(releases_path), the path to the folder to keep releases in, C(shared_path), the path to the folder to keep shared resources in, C(unfinished_filename), the file to check for to recognize unfinished builds, C(previous_release), the release the 'current' symlink is pointing to, C(previous_release_path), the full path to the 'current' symlink target, C(new_release), either the 'release' parameter or a generated timestamp, C(new_release_path), the path to the new release folder (not created by the module).

Digital Ocean Account Info *arguments

Gather information about DigitalOcean User account

Arguments:

This module can be used to gather information about User account. This module was called C(digital_ocean_account_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Block Storage *arguments

Create/destroy or attach/detach Block Storage volumes in DigitalOcean

Arguments: droplet_id, description, region, volume_name, state, command, snapshot_id, block_size

Create/destroy Block Storage volume in DigitalOcean, or attach/detach Block Storage volume to a droplet.

Digital Ocean Certificate *arguments

Manage certificates in DigitalOcean.

Arguments: leaf_certificate, private_key, state, certificate_chain, name

Create, Retrieve and remove certificates DigitalOcean.

Digital Ocean Certificate Info *arguments

Gather information about DigitalOcean certificates

Arguments: certificate_id

This module can be used to gather information about DigitalOcean provided certificates. This module was called C(digital_ocean_certificate_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Domain *arguments

Create/delete a DNS domain in DigitalOcean

Arguments: ip, state, id, name

Create/delete a DNS domain in DigitalOcean.

Digital Ocean Domain Info *arguments

Gather information about DigitalOcean Domains

Arguments: domain_name

This module can be used to gather information about DigitalOcean provided Domains. This module was called C(digital_ocean_domain_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Droplet *arguments

Create and delete a DigitalOcean droplet

Arguments: size, unique_name, tags, image, user_data, wait_timeout, backups, id, name, monitoring, ssh_keys, region, state, oauth_token, volumes, ipv6, private_networking, wait

Create and delete a droplet in DigitalOcean and optionally wait for it to be active.

Digital Ocean Firewall Info *arguments

Gather information about DigitalOcean firewalls

Arguments: name

This module can be used to gather information about DigitalOcean firewalls. This module was called C(digital_ocean_firewall_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Floating Ip *arguments

Manage DigitalOcean Floating IPs

Arguments: ip, state, oauth_token, region, droplet_id

Create/delete/assign a floating IP.

Digital Ocean Floating Ip Info *arguments

DigitalOcean Floating IPs information

Arguments:

This module can be used to fetch DigitalOcean Floating IPs information. This module was called C(digital_ocean_floating_ip_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Image Info *arguments

Gather information about DigitalOcean images

Arguments: image_type

This module can be used to gather information about DigitalOcean provided images. These images can be either of type C(distribution), C(application) and C(private). This module was called C(digital_ocean_image_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Load Balancer Info *arguments

Gather information about DigitalOcean load balancers

Arguments: load_balancer_id

This module can be used to gather information about DigitalOcean provided load balancers. This module was called C(digital_ocean_load_balancer_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Region Info *arguments

Gather information about DigitalOcean regions

Arguments:

This module can be used to gather information about regions. This module was called C(digital_ocean_region_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Size Info *arguments

Gather information about DigitalOcean Droplet sizes

Arguments:

This module can be used to gather information about droplet sizes. This module was called C(digital_ocean_size_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Snapshot Info *arguments

Gather information about DigitalOcean Snapshot

Arguments: snapshot_type, snapshot_id

This module can be used to gather information about snapshot information based upon provided values such as droplet, volume and snapshot id. This module was called C(digital_ocean_snapshot_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Sshkey *arguments

Manage DigitalOcean SSH keys

Arguments: state, fingerprint, oauth_token, ssh_pub_key, name

Create/delete DigitalOcean SSH keys.

Digital Ocean Sshkey Info *arguments

Gather information about DigitalOcean SSH keys

Arguments:

This module can be used to gather information about DigitalOcean SSH keys. This module replaces the C(digital_ocean_sshkey_facts) module.

Digital Ocean Tag *arguments

Create and remove tag(s) to DigitalOcean resource.

Arguments: state, name, resource_type, resource_id

Create and remove tag(s) to DigitalOcean resource.

Digital Ocean Tag Info *arguments

Gather information about DigitalOcean tags

Arguments: tag_name

This module can be used to gather information about DigitalOcean provided tags. This module was called C(digital_ocean_tag_facts) before Ansible 2.9. The usage did not change.

Digital Ocean Volume Info *arguments

Gather information about DigitalOcean volumes

Arguments: region_name

This module can be used to gather information about DigitalOcean provided volumes. This module was called C(digital_ocean_volume_facts) before Ansible 2.9. The usage did not change.

Dimensiondata Network *arguments

Create, update, and delete MCP 1.0 & 2.0 networks

Arguments: service_plan, state, name, description

Create, update, and delete MCP 1.0 & 2.0 networks

Dimensiondata Vlan *arguments

Manage a VLAN in a Cloud Control network domain.

Arguments: private_ipv4_prefix_size, state, network_domain, name, private_ipv4_base_address, allow_expand, description

Manage VLANs in Cloud Control network domains.

Django Manage *arguments

Manages a Django application.

Arguments: virtualenv, app_path, settings, pythonpath, clear, database, apps, cache_table, merge, command, skip, link, fixtures, failfast

Manages a Django application using the I(manage.py) application frontend to I(django-admin). With the I(virtualenv) parameter, all management commands will be executed by the given I(virtualenv) installation.

Dladm Etherstub *arguments

Manage etherstubs on Solaris/illumos systems.

Arguments: state, temporary, name

Create or delete etherstubs on Solaris/illumos systems.

Dladm Iptun *arguments

Manage IP tunnel interfaces on Solaris/illumos systems.

Arguments: state, temporary, name, local_address, type, remote_address

Manage IP tunnel interfaces on Solaris/illumos systems.

Dladm Linkprop *arguments

Manage link properties on Solaris/illumos systems.

Arguments: link, state, property, temporary, value

Set / reset link properties on Solaris/illumos systems.

Dladm Vlan *arguments

Manage VLAN interfaces on Solaris/illumos systems.

Arguments: link, state, temporary, name, vlan_id

Create or delete VLAN interfaces on Solaris/illumos systems.

Dladm Vnic *arguments

Manage VNICs on Solaris/illumos systems.

Arguments: state, temporary, name, link, vlan, mac

Create or delete VNICs on Solaris/illumos systems.

Dms Endpoint *arguments

creates or destroys a data migration services endpoint

Arguments: username, databasename, elasticsearchsettings, servername, dynamodbsettings, aws_region, serviceaccessrolearn, kmskeyid, dmstransfersettings, enginename, password, endpointidentifier, port, ec2_region, certificatearn, retries, region, tags, endpointtype, state, externaltabledefinition, extraconnectionattributes, timeout, sslmode, wait, mongodbsettings, kinesissettings, s3settings

creates or destroys a data migration services endpoint, that can be used to replicate data.

Dms Replication Subnet Group *arguments

creates or destroys a data migration services subnet group

Arguments: state, identifier, subnet_ids, description

Creates or destroys a data migration services subnet group

Dnf *arguments

Manages packages with the I(dnf) package manager

Arguments: install_weak_deps, autoremove, lock_timeout, download_dir, install_repoquery, update_cache, disable_excludes, exclude, installroot, allow_downgrade, name, download_only, bugfix, list, disable_gpg_check, conf_file, update_only, validate_certs, state, disablerepo, releasever, disable_plugin, enablerepo, skip_broken, security, enable_plugin

Installs, upgrade, removes, and lists packages and groups with the I(dnf) package manager.

Dnsimple *arguments

Interface with dnsimple.com (a DNS hosting service)

Arguments: solo, domain, account_email, record_ids, value, priority, record, state, ttl, type, account_api_token

Manages domains and records via the DNSimple API, see the docs: U(http://developer.dnsimple.com/).

Dnsmadeeasy *arguments

Interface with dnsmadeeasy.com (a DNS hosting service).

Arguments: httpFqdn, domain, protocol, autoFailover, record_ttl, sensitivity, contactList, account_key, ip2, record_type, ip1, ip4, ip5, record_name, port, monitor, ip3, httpQueryString, failover, sandbox, maxEmails, state, systemDescription, record_value, httpFile, validate_certs, account_secret

Manages DNS records via the v2 REST API of the DNS Made Easy service. It handles records only; there is no manipulation of domains or monitor/account support yet. See: U(https://www.dnsmadeeasy.com/integration/restapi/)

Docker Compose *arguments

Manage multi-container Docker applications with Docker Compose.

Arguments: files, project_name, project_src, hostname_check, recreate, dependencies, remove_images, services, pull, definition, scale, nocache, remove_orphans, restarted, state, remove_volumes, stopped, build, timeout

Uses Docker Compose to start, shutdown and scale services. Works with compose versions 1 and 2. Configuration can be read from a C(docker-compose.yml) or C(docker-compose.yaml) file or inline using the I(definition) option. See the examples for more details. Supports check mode. This module was called C(docker_service) before Ansible 2.8. The usage did not change.

Docker Config *arguments

Manage docker configs.

Arguments: state, force, name, data_is_b64, labels, data

Create and remove Docker configs in a Swarm environment. Similar to C(docker config create) and C(docker config rm). Adds to the metadata of new configs 'ansible_key', an encrypted hash representation of the data, which is then used in future runs to test if a config has changed. If 'ansible_key' is not present, then a config will not be updated unless the I(force) option is set. Updates to configs are performed by removing the config and creating it again.

Docker Container *arguments

manage docker containers

Arguments: tty, dns_servers, image, labels, pids_limit, cpuset_cpus, force_kill, pid_mode, networks_cli_compatible, networks, cpu_period, tmpfs, device_read_bps, domainname, working_dir, capabilities, init, memory_swap, mac_address, volumes_from, log_options, device_write_iops, recreate, ipc_mode, memory, memory_swappiness, network_mode, detach, restart, pull, name, stop_signal, devices, uts, blkio_weight, mounts, stop_timeout, cap_drop, ulimits, cpu_shares, interactive, links, oom_score_adj, command, paused, dns_search_domains, kernel_memory, env_file, cpu_quota, read_only, cpuset_mems, hostname, dns_opts, state, cleanup, entrypoint, env, healthcheck, keep_volumes, published_ports, privileged, exposed_ports, trust_image_content, auto_remove, log_driver, oom_killer, shm_size, kill_signal, volume_driver, restart_retries, groups, userns_mode, purge_networks, output_logs, ignore_image, device_read_iops, restart_policy, security_opts, etc_hosts, sysctls, memory_reservation, volumes, comparisons, runtime, device_write_bps, user

Manage the life cycle of docker containers. Supports check mode. Run with C(--check) and C(--diff) to view config difference and list of actions to be taken.

Docker Container Info *arguments

Retrieves facts about docker container

Arguments: name

Retrieves facts about a docker container. Essentially returns the output of C(docker inspect <name>), similar to what M(docker_container) returns for a non-absent container.

Docker Host Info *arguments

Retrieves facts about docker host and lists of objects of the services.

Arguments: networks_filters, images_filters, disk_usage, volumes_filters, verbose_output, networks, volumes, images, containers_filters, containers

Retrieves facts about a docker host. Essentially returns the output of C(docker system info). The module also allows to list object names for containers, images, networks and volumes. It also allows to query information on disk usage. The output differs depending on API version of the docker daemon. If the docker daemon cannot be contacted or does not meet the API version requirements, the module will fail.

Docker Image *arguments

Manage docker images.

Arguments: archive_path, force, repository, force_absent, tag, force_source, path, pull, name, nocache, container_limits, dockerfile, force_tag, load_path, use_tls, source, state, build, buildargs, push, rm, http_timeout

Build, load or pull an image, making the image available for creating containers. Also supports tagging an image into a repository and archiving an image to a .tar file. Since Ansible 2.8, it is recommended to explicitly specify the image's source (I(source) can be C(build), C(load), C(pull) or C(local)). This will be required from Ansible 2.12 on.

Docker Image Info *arguments

Inspect docker images

Arguments: name

Provide one or more image names, and the module will inspect each, returning an array of inspection results. If an image does not exist locally, it will not appear in the results. If you want to check whether an image exists locally, you can call the module with the image name, then check whether the result list is empty (image does not exist) or has one element (the image exists locally). The module will not attempt to pull images from registries. Use M(docker_image) with I(source) set to C(pull) to ensure an image is pulled.

Docker Login *arguments

Log into a Docker registry.

Arguments: username, state, config_path, reauthorize, password, email, registry_url

Provides functionality similar to the "docker login" command. Authenticate with a docker registry and add the credentials to your local Docker config file. Adding the credentials to the config files allows future connections to the registry using tools such as Ansible's Docker modules, the Docker CLI and Docker SDK for Python without needing to provide credentials. Running in check mode will perform the authentication without updating the config file.

Docker Network *arguments

Manage Docker networks

Arguments: force, ipam_config, labels, driver, driver_options, connected, ipam_driver, attachable, name, ipam_driver_options, enable_ipv6, ipam_options, state, internal, scope, appends

Create/remove Docker networks and connect containers to them. Performs largely the same function as the "docker network" CLI subcommand.

Docker Network Info *arguments

Retrieves facts about docker network

Arguments: name

Retrieves facts about a docker network. Essentially returns the output of C(docker network inspect <name>), similar to what M(docker_network) returns for a non-absent network.

Docker Node *arguments

Manage Docker Swarm node

Arguments: labels, role, labels_state, labels_to_remove, hostname, availability

Manages the Docker nodes via Swarm Manager. This module allows to change the node's role, its availability, and to modify, add or remove node labels.

Docker Node Info *arguments

Retrieves facts about docker swarm node from Swarm Manager

Arguments: self, name

Retrieves facts about a docker node. Essentially returns the output of C(docker node inspect <name>). Must be executed on a host running as Swarm Manager, otherwise the module will fail.

Docker Prune *arguments

Allows to prune various docker objects

Arguments: networks_filters, images_filters, volumes_filters, builder_cache, networks, volumes, images, containers_filters, containers

Allows to run C(docker container prune), C(docker image prune), C(docker network prune) and C(docker volume prune) via the Docker API.

Docker Secret *arguments

Manage docker secrets.

Arguments: state, force, name, data_is_b64, labels, data

Create and remove Docker secrets in a Swarm environment. Similar to C(docker secret create) and C(docker secret rm). Adds to the metadata of new secrets 'ansible_key', an encrypted hash representation of the data, which is then used in future runs to test if a secret has changed. If 'ansible_key is not present, then a secret will not be updated unless the I(force) option is set. Updates to secrets are performed by removing the secret and creating it again.

Docker Stack *arguments

docker stack module

Arguments: compose, name, resolve_image, state, absent_retries_interval, with_registry_auth, absent_retries, prune

Manage docker stacks using the 'docker stack' command on the target node (see examples).

Docker Swarm *arguments

Manage Swarm cluster

Arguments: rotate_worker_token, force, snapshot_interval, node_cert_expiry, election_tick, labels, node_id, dispatcher_heartbeat_period, ca_force_rotate, subnet_size, advertise_addr, task_history_retention_limit, log_entries_for_slow_followers, join_token, name, heartbeat_tick, listen_addr, keep_old_snapshots, state, rotate_manager_token, signing_ca_cert, autolock_managers, signing_ca_key, remote_addrs, default_addr_pool

Create a new Swarm cluster. Add/Remove nodes or managers to an existing cluster.

Docker Swarm Info *arguments

Retrieves facts about Docker Swarm cluster.

Arguments: tasks, services_filters, verbose_output, nodes_filters, tasks_filters, services, nodes, unlock_key

Retrieves facts about a Docker Swarm. Returns lists of swarm objects names for the services - nodes, services, tasks. The output differs depending on API version available on docker host. Must be run on Swarm Manager node; otherwise module fails with error message. It does return boolean flags in on both error and success which indicate whether the docker daemon can be communicated with, whether it is in Swarm mode, and whether it is a Swarm Manager node.

Docker Swarm Service *arguments

docker swarm service

Arguments: tty, reserve_memory, update_max_failure_ratio, reservations, image, labels, restart_policy_window, networks, read_only, dns_options, log_driver_options, hostname, state, publish, update_config, working_dir, env, healthcheck, command, update_monitor, rollback_config, update_delay, log_driver, endpoint_mode, resolve_image, replicas, args, env_files, limit_memory, limit_cpu, user, groups, reserve_cpu, logging, configs, restart_policy, restart_config, limits, dns, placement, name, stop_grace_period, stop_signal, update_parallelism, force_update, restart_policy_attempts, dns_search, update_failure_action, secrets, restart_policy_delay, hosts, mode, mounts, update_order, constraints, container_labels

Manages docker services via a swarm manager node.

Docker Swarm Service Info *arguments

Retrieves information about docker services from a Swarm Manager

Arguments: name

Retrieves information about a docker service. Essentially returns the output of C(docker service inspect <name>). Must be executed on a host running as Swarm Manager, otherwise the module will fail.

Docker Volume *arguments

Manage Docker volumes

Arguments: state, labels, force, volume_name, driver_options, recreate, driver

Create/remove Docker volumes. Performs largely the same function as the "docker volume" CLI subcommand.

Docker Volume Info *arguments

Retrieve facts about Docker volumes

Arguments: name

Performs largely the same function as the "docker volume inspect" CLI subcommand.

Dpkg Selections *arguments

Dpkg package selection selections

Arguments: selection, name

Change dpkg package selection state via --get-selections and --set-selections.

Dynamodb Table *arguments

Create, update or delete AWS Dynamo DB tables.

Arguments: read_capacity, hash_key_name, range_key_type, name, tags, write_capacity, indexes, range_key_name, state, wait_for_active_timeout, hash_key_type

Create or delete AWS Dynamo DB tables. Can update the provisioned throughput on existing tables. Returns the status of the specified table.

Dynamodb Ttl *arguments

set TTL for a given DynamoDB table.

Arguments: table_name, state, attribute_name

Uses boto3 to set TTL. requires botocore version 1.5.24 or higher.

Easy Install *arguments

Installs Python libraries

Arguments: virtualenv, virtualenv_site_packages, virtualenv_command, name, state, executable

Installs Python libraries, optionally in a I(virtualenv)

Ec 2 *arguments

create, terminate, start or stop an instance in ec2

Arguments: kernel, image, monitoring, user_data, termination_protection, private_ip, spot_type, id, source_dest_check, spot_wait_timeout, group, zone, exact_count, ebs_optimized, state, placement_group, key_name, ramdisk, count_tag, spot_launch_group, vpc_subnet_id, instance_ids, tenancy, assign_public_ip, spot_price, wait, count, instance_profile_name, region, network_interfaces, instance_initiated_shutdown_behavior, instance_type, wait_timeout, volumes, instance_tags, group_id

Creates or terminates ec2 instances.

Ec2 Ami *arguments

create or destroy an image in ec2

Arguments: image_location, description, tags, enhanced_networking, purge_tags, launch_permissions, ramdisk_id, image_id, no_reboot, wait_timeout, wait, name, delete_snapshot, billing_products, instance_id, kernel_id, state, architecture, device_mapping, virtualization_type, sriov_net_support, root_device_name

Registers or deregisters ec2 images.

Ec2 Ami Copy *arguments

copies AMI between AWS regions, return new image id

Arguments: name, tags, encrypted, description, kms_key_id, source_image_id, tag_equality, wait_timeout, source_region, wait

Copies AMI from a source region to a destination region. B(Since version 2.3 this module depends on boto3.)

Ec2 Ami Info *arguments

Gather information about ec2 AMIs

Arguments: image_ids, owners, describe_image_attributes, filters, executable_users

Gather information about ec2 AMIs This module was called C(ec2_ami_facts) before Ansible 2.9. The usage did not change.

Ec2 Asg *arguments

Create or delete AWS Autoscaling Groups

Arguments: health_check_type, target_group_arns, default_cooldown, tags, metrics_list, min_size, wait_timeout, launch_template, health_check_period, load_balancers, launch_config_name, name, metrics_collection, lc_check, availability_zones, replace_batch_size, replace_all_instances, metrics_granularity, suspend_processes, termination_policies, replace_instances, desired_capacity, state, vpc_zone_identifier, max_size, placement_group, notification_topic, notification_types, wait_for_instances, lt_check

Can create or delete AWS Autoscaling Groups Can be used with the ec2_lc module to manage Launch Configurations

Ec2 Asg Info *arguments

Gather information about ec2 Auto Scaling Groups (ASGs) in AWS

Arguments: name, tags

Gather information about ec2 Auto Scaling Groups (ASGs) in AWS This module was called C(ec2_asg_facts) before Ansible 2.9. The usage did not change.

Ec2 Asg Lifecycle Hook *arguments

Create, delete or update AWS ASG Lifecycle Hooks.

Arguments: lifecycle_hook_name, role_arn, autoscaling_group_name, transition, heartbeat_timeout, state, notification_target_arn, default_result, notification_meta_data

When no given Hook found, will create one. In case Hook found, but provided parameters are differes, will update existing Hook. In case state=absent and Hook exists, will delete it.

Ec2 Customer Gateway *arguments

Manage an AWS customer gateway

Arguments: state, bgp_asn, ip_address, routing, name

Manage an AWS customer gateway

Ec2 Customer Gateway Info *arguments

Gather information about customer gateways in AWS

Arguments: customer_gateway_ids, filters

Gather information about customer gateways in AWS This module was called C(ec2_customer_gateway_facts) before Ansible 2.9. The usage did not change.

Ec2 Eip *arguments

manages EC2 elastic IP (EIP) addresses.

Arguments: release_on_disassociation, public_ip, state, reuse_existing_ip_allowed, allow_reassociation, tag_value, public_ipv4_pool, tag_name, in_vpc, private_ip_address, device_id

This module can allocate or release an EIP. This module can associate/disassociate an EIP with instances or network interfaces.

Ec2 Eip Info *arguments

List EC2 EIP details

Arguments: filters

List details of EC2 Elastic IP addresses. This module was called C(ec2_eip_facts) before Ansible 2.9. The usage did not change.

Ec2 Elb *arguments

De-registers or registers instances from EC2 ELBs

Arguments: instance_id, state, wait_timeout, wait, validate_certs, enable_availability_zone, ec2_elbs

This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. Returns fact "ec2_elbs" which is a list of elbs attached to the instance if state=absent is passed as an argument. Will be marked changed when called only if there are ELBs found to operate on.

Ec2 Elb Info *arguments

Gather information about EC2 Elastic Load Balancers in AWS

Arguments: names

Gather information about EC2 Elastic Load Balancers in AWS This module was called C(ec2_elb_facts) before Ansible 2.9. The usage did not change.

Ec2 Elb Lb *arguments

Creates, updates or destroys an Amazon ELB.

Arguments: subnets, health_check, tags, purge_subnets, instance_ids, zones, idle_timeout, wait_timeout, cross_az_load_balancing, security_group_ids, purge_zones, wait, purge_instance_ids, connection_draining_timeout, name, listeners, access_logs, state, security_group_names, purge_listeners, scheme, validate_certs, stickiness

Returns information about the load balancer. Will be marked changed when called only if state is changed.

Ec2 Eni *arguments

Create and optionally attach an Elastic Network Interface (ENI) to an instance

Arguments: allow_reassignment, description, purge_secondary_private_ip_addresses, source_dest_check, secondary_private_ip_addresses, subnet_id, device_index, attached, force_detach, instance_id, state, security_groups, private_ip_address, secondary_private_ip_address_count, eni_id, delete_on_termination

Create and optionally attach an Elastic Network Interface (ENI) to an instance. If an ENI ID or private_ip is provided, the existing ENI (if any) will be modified. The 'attached' parameter controls the attachment status of the network interface.

Ec2 Eni Info *arguments

Gather information about ec2 ENI interfaces in AWS

Arguments: filters

Gather information about ec2 ENI interfaces in AWS This module was called C(ec2_eni_facts) before Ansible 2.9. The usage did not change.

Ec2 Group *arguments

maintain an ec2 VPC security group.

Arguments: rules_egress, name, purge_rules, tags, rules, purge_tags, description, state, vpc_id, group_id, purge_rules_egress

maintains ec2 security groups. This module has a dependency on python-boto >= 2.5

Ec2 Group Info *arguments

Gather information about ec2 security groups in AWS.

Arguments: filters

Gather information about ec2 security groups in AWS. This module was called C(ec2_group_facts) before Ansible 2.9. The usage did not change.

Ec2 Instance *arguments

Create & manage EC2 instances

Arguments: volumes, availability_zone, purge_tags, image, vpc_subnet_id, user_data, instance_ids, tower_callback, image_id, termination_protection, tenancy, launch_template, filters, security_groups, wait, instance_role, network, wait_timeout, ebs_optimized, cpu_credit_specification, instance_initiated_shutdown_behavior, name, instance_type, state, tags, placement_group, key_name, security_group, cpu_options, detailed_monitoring

Create and manage AWS EC2 instance

Ec2 Instance Info *arguments

Gather information about ec2 instances in AWS

Arguments: instance_ids, filters

Gather information about ec2 instances in AWS This module was called C(ec2_instance_facts) before Ansible 2.9. The usage did not change.

Ec2 Key *arguments

create or delete an ec2 key pair

Arguments: state, wait_timeout, force, name, wait, key_material

create or delete an ec2 key pair.

Ec2 Launch Template *arguments

Manage EC2 launch templates

Arguments: default_version, network_interfaces, tags, kernel_id, template_name, user_data, instance_initiated_shutdown_behavior, image_id, cpu_options, ram_disk_id, placement, security_group_ids, security_groups, block_device_mappings, elastic_gpu_specifications, monitoring, credit_specification, ebs_optimized, iam_instance_profile, instance_type, state, disable_api_termination, instance_market_options, template_id, key_name

Create, modify, and delete EC2 Launch Templates, which can be used to create individual instances or with Autoscaling Groups. The I(ec2_instance) and I(ec2_asg) modules can, instead of specifying all parameters on those tasks, be passed a Launch Template which contains settings like instance size, disk type, subnet, and more.

Ec2 Lc *arguments

Create or delete AWS Autoscaling Launch Configurations

Arguments: kernel_id, key_name, ramdisk_id, user_data, image_id, assign_public_ip, instance_monitoring, classic_link_vpc_id, security_groups, classic_link_vpc_security_groups, spot_price, name, instance_profile_name, user_data_path, ebs_optimized, instance_id, instance_type, state, volumes, vpc_id, placement_tenancy

Can create or delete AWS Autoscaling Configurations Works with the ec2_asg module to manage Autoscaling Groups

Ec2 Lc Find *arguments

Find AWS Autoscaling Launch Configurations

Arguments: sort_order, region, name_regex, limit

Returns list of matching Launch Configurations for a given name, along with other useful information Results can be sorted and sliced It depends on boto Based on the work by Tom Bamford (https://github.com/tombamford)

Ec2 Lc Info *arguments

Gather information about AWS Autoscaling Launch Configurations

Arguments: sort, sort_end, sort_order, name, sort_start

Gather information about AWS Autoscaling Launch Configurations This module was called C(ec2_lc_facts) before Ansible 2.9. The usage did not change.

Ec2 Metadata Facts *arguments

Gathers facts (instance metadata) about remote hosts within ec2

Arguments:

This module fetches data from the instance metadata endpoint in ec2 as per U(https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html). The module must be called from within the EC2 instance itself.

Ec2 Metric Alarm *arguments

Create/update or delete AWS Cloudwatch 'metric alarms'

Arguments: comparison, alarm_actions, ok_actions, name, evaluation_periods, metric, description, namespace, period, state, insufficient_data_actions, statistic, threshold, unit, dimensions

Can create or delete AWS metric alarms. Metrics you wish to alarm on must already exist.

Ec2 Placement Group *arguments

Create or delete an EC2 Placement Group

Arguments: state, name, strategy

Create an EC2 Placement Group; if the placement group already exists, nothing is done. Or, delete an existing placement group. If the placement group is absent, do nothing. See also U(https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html)

Ec2 Placement Group Info *arguments

List EC2 Placement Group(s) details

Arguments: names

List details of EC2 Placement Group(s). This module was called C(ec2_placement_group_facts) before Ansible 2.9. The usage did not change.

Ec2 Scaling Policy *arguments

Create or delete AWS scaling policies for Autoscaling groups

Arguments: state, cooldown, name, asg_name, adjustment_type, min_adjustment_step, scaling_adjustment

Can create or delete scaling policies for autoscaling groups Referenced autoscaling groups must already exist

Ec2 Snapshot *arguments

creates a snapshot from an existing volume

Arguments: description, snapshot_tags, volume_id, device_name, instance_id, state, wait_timeout, snapshot_id, last_snapshot_min_age, wait

creates an EC2 snapshot from an existing EBS volume

Ec2 Snapshot Copy *arguments

copies an EC2 snapshot and returns the new Snapshot ID.

Arguments: description, tags, encrypted, kms_key_id, wait_timeout, source_region, source_snapshot_id, wait

Copies an EC2 Snapshot from a source region to a destination region.

Ec2 Snapshot Info *arguments

Gather information about ec2 volume snapshots in AWS

Arguments: restorable_by_user_ids, snapshot_ids, filters, owner_ids

Gather information about ec2 volume snapshots in AWS This module was called C(ec2_snapshot_facts) before Ansible 2.9. The usage did not change.

Ec2 Tag *arguments

create and remove tags on ec2 resources.

Arguments: purge_tags, state, resource, tags

Creates, removes and lists tags for any EC2 resource. The resource is referenced by its resource id (e.g. an instance being i-XXXXXXX). It is designed to be used with complex args (tags), see the examples.

Ec2 Transit Gateway *arguments

Create and delete AWS Transit Gateways.

Arguments: transit_gateway_id, description, dns_support, tags, purge_tags, state, wait_timeout, auto_attach, auto_associate, auto_propagate, vpn_ecmp_support, asn, wait

Creates AWS Transit Gateways Deletes AWS Transit Gateways Updates tags on existing transit gateways

Ec2 Transit Gateway Info *arguments

Gather information about ec2 transit gateways in AWS

Arguments: transit_gateway_ids, filters

Gather information about ec2 transit gateways in AWS

Ec2 Vol *arguments

create and attach a volume, return volume id and device map

Arguments: name, zone, instance, encrypted, kms_key_id, volume_type, device_name, volume_size, state, iops, snapshot, id, validate_certs, delete_on_termination, tags

creates an EBS volume and optionally attaches it to an instance. If both an instance ID and a device name is given and the instance has a device at the device name, then no volume is created and no attachment is made. This module has a dependency on python-boto.

Ec2 Vol Info *arguments

Gather information about ec2 volumes in AWS

Arguments: filters

Gather information about ec2 volumes in AWS This module was called C(ec2_vol_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Dhcp Option *arguments

Manages DHCP Options, and can ensure the DHCP options for the given VPC match what's requested

Arguments: dns_servers, tags, ntp_servers, domain_name, delete_old, state, netbios_node_type, vpc_id, inherit_existing, dhcp_options_id, netbios_name_servers

This module removes, or creates DHCP option sets, and can associate them to a VPC. Optionally, a new DHCP Options set can be created that converges a VPC's existing DHCP option set with values provided. When dhcp_options_id is provided, the module will 1. remove (with state='absent') 2. ensure tags are applied (if state='present' and tags are provided 3. attach it to a VPC (if state='present' and a vpc_id is provided. If any of the optional values are missing, they will either be treated as a no-op (i.e., inherit what already exists for the VPC) To remove existing options while inheriting, supply an empty value (e.g. set ntp_servers to [] if you want to remove them from the VPC's options) Most of the options should be self-explanatory.

Ec2 Vpc Dhcp Option Info *arguments

Gather information about dhcp options sets in AWS

Arguments: dhcp_options_ids, filters

Gather information about dhcp options sets in AWS This module was called C(ec2_vpc_dhcp_option_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Egress Igw *arguments

Manage an AWS VPC Egress Only Internet gateway

Arguments: vpc_id, state

Manage an AWS VPC Egress Only Internet gateway

Ec2 Vpc Endpoint *arguments

Create and delete AWS VPC Endpoints.

Arguments: policy_file, service, state, vpc_endpoint_id, wait_timeout, policy, vpc_id, client_token, route_table_ids, wait

Creates AWS VPC endpoints. Deletes AWS VPC endpoints. This module support check mode.

Ec2 Vpc Endpoint Info *arguments

Retrieves AWS VPC endpoints details using AWS methods.

Arguments: query, vpc_endpoint_ids, filters

Gets various details related to AWS VPC Endpoints This module was called C(ec2_vpc_endpoint_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Igw *arguments

Manage an AWS VPC Internet gateway

Arguments: vpc_id, state, tags

Manage an AWS VPC Internet gateway

Ec2 Vpc Igw Info *arguments

Gather information about internet gateways in AWS

Arguments: filters, internet_gateway_ids

Gather information about internet gateways in AWS. This module was called C(ec2_vpc_igw_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Nacl *arguments

create and delete Network ACLs.

Arguments: subnets, ingress, name, tags, state, egress, vpc_id, nacl_id

Read the AWS documentation for Network ACLS U(https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html)

Ec2 Vpc Nacl Info *arguments

Gather information about Network ACLs in an AWS VPC

Arguments: nacl_ids, filters

Gather information about Network ACLs in an AWS VPC This module was called C(ec2_vpc_nacl_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Nat Gateway *arguments

Manage AWS VPC NAT Gateways.

Arguments: release_eip, nat_gateway_id, allocation_id, subnet_id, if_exist_do_not_create, eip_address, state, wait_timeout, client_token, wait

Ensure the state of AWS VPC NAT Gateways based on their id, allocation and subnet ids.

Ec2 Vpc Nat Gateway Info *arguments

Retrieves AWS VPC Managed Nat Gateway details using AWS methods.

Arguments: nat_gateway_ids, filters

Gets various details related to AWS VPC Managed Nat Gateways This module was called C(ec2_vpc_nat_gateway_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Net *arguments

Configure AWS virtual private clouds

Arguments: purge_cidrs, name, dns_support, tags, multi_ok, state, tenancy, dns_hostnames, cidr_block, dhcp_opts_id

Create, modify, and terminate AWS virtual private clouds.

Ec2 Vpc Net Info *arguments

Gather information about ec2 VPCs in AWS

Arguments: vpc_ids, filters

Gather information about ec2 VPCs in AWS This module was called C(ec2_vpc_net_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Peer *arguments

create, delete, accept, and reject VPC peering connections between two VPCs.

Arguments: state, peering_id, tags, peer_region, vpc_id, peer_vpc_id, peer_owner_id

Read the AWS documentation for VPC Peering Connections U(https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-peering.html).

Ec2 Vpc Peering Info *arguments

Retrieves AWS VPC Peering details using AWS methods.

Arguments: peer_connection_ids, filters

Gets various details related to AWS VPC Peers This module was called C(ec2_vpc_peering_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Route Table *arguments

Manage route tables for AWS virtual private clouds

Arguments: subnets, tags, purge_tags, purge_subnets, purge_routes, route_table_id, state, lookup, routes, vpc_id, propagating_vgw_ids

Manage route tables for AWS virtual private clouds

Ec2 Vpc Route Table Info *arguments

Gather information about ec2 VPC route tables in AWS

Arguments: filters

Gather information about ec2 VPC route tables in AWS This module was called C(ec2_vpc_route_table_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Subnet *arguments

Manage subnets in AWS virtual private clouds

Arguments: az, ipv6_cidr, tags, purge_tags, state, wait_timeout, map_public, vpc_id, cidr, assign_instances_ipv6, wait

Manage subnets in AWS virtual private clouds

Ec2 Vpc Subnet Info *arguments

Gather information about ec2 VPC subnets in AWS

Arguments: subnet_ids, filters

Gather information about ec2 VPC subnets in AWS This module was called C(ec2_vpc_subnet_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Vgw *arguments

Create and delete AWS VPN Virtual Gateways.

Arguments: name, tags, state, wait_timeout, vpc_id, vpn_gateway_id, type, asn

Creates AWS VPN Virtual Gateways Deletes AWS VPN Virtual Gateways Attaches Virtual Gateways to VPCs Detaches Virtual Gateways from VPCs

Ec2 Vpc Vgw Info *arguments

Gather information about virtual gateways in AWS

Arguments: vpn_gateway_ids, filters

Gather information about virtual gateways in AWS. This module was called C(ec2_vpc_vgw_facts) before Ansible 2.9. The usage did not change.

Ec2 Vpc Vpn *arguments

Create, modify, and delete EC2 VPN connections.

Arguments: connection_type, customer_gateway_id, tags, purge_tags, tunnel_options, state, delay, purge_routes, wait_timeout, vpn_connection_id, filters, routes, vpn_gateway_id, static_only

This module creates, modifies, and deletes VPN connections. Idempotence is achieved by using the filters option or specifying the VPN connection identifier.

Ec2 Vpc Vpn Info *arguments

Gather information about VPN Connections in AWS.

Arguments: filters, vpn_connection_ids

Gather information about VPN Connections in AWS. This module was called C(ec2_vpc_vpn_facts) before Ansible 2.9. The usage did not change.

Ec2 Win Password *arguments

gets the default administrator password for ec2 windows instances

Arguments: key_data, instance_id, key_passphrase, wait_timeout, key_file, wait

Gets the default administrator password from any EC2 Windows instance. The instance is referenced by its id (e.g. C(i-XXXXXXX)). This module has a dependency on python-boto.

Ecs Attribute *arguments

manage ecs attributes

Arguments: cluster, state, ec2_instance_id, attributes

Create, update or delete ECS container instance attributes.

Ecs Certificate *arguments

Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API

Arguments: requester_email, force, full_chain_path, subject_alt_name, cert_lifetime, end_user_key_storage_agreement, cert_type, request_type, client_id, org, path, remaining_days, eku, custom_fields, additional_emails, cert_expiry, requester_name, tracking_info, requester_phone, tracking_id, ct_log, ou, backup, csr

Create, reissue, and renew certificates with the Entrust Certificate Services (ECS) API. Requires credentials for the L(Entrust Certificate Services,https://www.entrustdatacard.com/products/categories/ssl-certificates) (ECS) API. In order to request a certificate, the domain and organization used in the certificate signing request must be already validated in the ECS system. It is I(not) the responsibility of this module to perform those steps.

Ecs Cluster *arguments

create or terminate ecs clusters

Arguments: delay, state, repeat, name

Creates or terminates ecs clusters.

Ecs Ecr *arguments

Manage Elastic Container Registry repositories

Arguments: force_set_policy, state, name, policy, registry_id, delete_policy

Manage Elastic Container Registry repositories

Ecs Service *arguments

create, terminate, start or stop a service in ecs

Arguments: repeat, network_configuration, health_check_grace_period_seconds, desired_count, cluster, deployment_configuration, scheduling_strategy, load_balancers, force_new_deployment, name, placement_constraints, state, delay, task_definition, service_registries, role, client_token, placement_strategy, launch_type

Creates or terminates ecs services.

Ecs Service Info *arguments

list or describe services in ecs

Arguments: cluster, details, service, events

Lists or describes services in ecs. This module was called C(ecs_service_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ecs_service_info) module no longer returns C(ansible_facts)!

Ecs Task *arguments

run, start or stop a task in ecs

Arguments: count, task, network_configuration, overrides, started_by, cluster, task_definition, container_instances, operation, launch_type

Creates or deletes instances of task definitions.

Ecs Taskdefinition *arguments

register a task definition in ecs

Arguments: family, task_role_arn, force_create, execution_role_arn, network_mode, state, containers, volumes, memory, revision, cpu, arn, launch_type

Registers or deregisters task definitions in the Amazon Web Services (AWS) EC2 Container Service (ECS)

Ecs Taskdefinition Info *arguments

describe a task definition in ecs

Arguments: task_definition

Describes a task definition in ecs.

Edgeos Command *arguments

Run one or more commands on EdgeOS devices

Arguments: retries, commands, wait_for, match, interval

This command module allows running one or more commands on a remote device running EdgeOS, such as the Ubiquiti EdgeRouter. This module does not support running commands in configuration mode. Certain C(show) commands in EdgeOS produce many lines of output and use a custom pager that can cause this module to hang. If the value of the environment variable C(ANSIBLE_EDGEOS_TERMINAL_LENGTH) is not set, the default number of 10000 is used. This is a network module and requires C(connection: network_cli) in order to work properly. For more information please see the L(Network Guide,../network/getting_started/index.html).

Edgeos Config *arguments

Manage EdgeOS configuration on remote device

Arguments: comment, src, backup_options, config, lines, save, backup, match

This module provides configuration file management of EdgeOS devices. It provides arguments for managing both the configuration file and state of the active configuration. All configuration statements are based on set and delete commands in the device configuration. This is a network module and requires the C(connection: network_cli) in order to work properly. For more information please see the L(Network Guide,../network/getting_started/index.html).

Edgeos Facts *arguments

Collect facts from remote devices running EdgeOS

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running EdgeOS. This module prepends all of the base network fact keys with U(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Edgeswitch Facts *arguments

Collect facts from remote devices running Edgeswitch

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running Ubiquiti Edgeswitch. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Edgeswitch Vlan *arguments

Manage VLANs on Ubiquiti Edgeswitch network devices

Arguments: auto_tag, name, untagged_interfaces, auto_exclude, excluded_interfaces, purge, state, tagged_interfaces, aggregate, auto_untag, vlan_id

This module provides declarative management of VLANs on Ubiquiti Edgeswitch network devices.

Efs *arguments

create and maintain EFS file systems

Arguments: encrypt, name, tags, purge_tags, kms_key_id, provisioned_throughput_in_mibps, id, state, wait_timeout, throughput_mode, performance_mode, targets, wait

Module allows create, search and destroy Amazon EFS file systems

Efs Info *arguments

Get information about Amazon EFS file systems

Arguments: id, targets, name, tags

This module can be used to search Amazon EFS file systems. This module was called C(efs_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(efs_info) module no longer returns C(ansible_facts)!

Ejabberd User *arguments

Manages users for ejabberd servers

Arguments: username, host, password, logging, state

This module provides user management for ejabberd servers

Elasticache *arguments

Manage cache clusters in Amazon Elasticache.

Arguments: engine, cache_port, cache_parameter_group, name, cache_engine_version, state, node_type, num_nodes, zone, cache_security_groups, cache_subnet_group, hard_modify, security_group_ids, wait

Manage cache clusters in Amazon Elasticache. Returns information about the specified cache cluster.

Elasticache Info *arguments

Retrieve information for AWS Elasticache clusters

Arguments: name

Retrieve information from AWS Elasticache clusters This module was called C(elasticache_facts) before Ansible 2.9. The usage did not change.

Elasticache Parameter Group *arguments

Manage cache security groups in Amazon Elasticache.

Arguments: group_family, state, values, name, description

Manage cache security groups in Amazon Elasticache. Returns information about the specified cache cluster.

Elasticache Snapshot *arguments

Manage cache snapshots in Amazon Elasticache.

Arguments: state, replication_id, name, cluster_id, bucket, target

Manage cache snapshots in Amazon Elasticache. Returns information about the specified snapshot.

Elasticache Subnet Group *arguments

manage Elasticache subnet groups

Arguments: subnets, state, name, description

Creates, modifies, and deletes Elasticache subnet groups. This module has a dependency on python-boto >= 2.5.

Elasticsearch Plugin *arguments

Manage Elasticsearch plugins

Arguments: src, force, name, proxy_host, url, proxy_port, state, version, timeout, plugin_dir, plugin_bin

Manages Elasticsearch plugins.

Elb Application Lb *arguments

Manage an Application load balancer

Arguments: subnets, purge_rules, tags, purge_tags, idle_timeout, wait_timeout, access_logs_s3_prefix, security_groups, wait, access_logs_enabled, access_logs_s3_bucket, listeners, name, state, deletion_protection, purge_listeners, http2, scheme

Manage an AWS Application Elastic Load Balancer. See U(https://aws.amazon.com/blogs/aws/new-aws-application-load-balancer/) for details.

Elb Application Lb Info *arguments

Gather information about application ELBs in AWS

Arguments: names, load_balancer_arns

Gather information about application ELBs in AWS This module was called C(elb_application_lb_facts) before Ansible 2.9. The usage did not change.

Elb Classic Lb *arguments

Creates or destroys Amazon ELB.

Arguments: subnets, health_check, tags, purge_subnets, instance_ids, zones, idle_timeout, wait_timeout, cross_az_load_balancing, security_group_ids, purge_zones, wait, purge_instance_ids, connection_draining_timeout, name, listeners, access_logs, state, security_group_names, purge_listeners, scheme, validate_certs, stickiness

Returns information about the load balancer. Will be marked changed when called only if state is changed.

Elb Classic Lb Info *arguments

Gather information about EC2 Elastic Load Balancers in AWS

Arguments: names

Gather information about EC2 Elastic Load Balancers in AWS This module was called C(elb_classic_lb_facts) before Ansible 2.9. The usage did not change.

Elb Instance *arguments

De-registers or registers instances from EC2 ELBs

Arguments: instance_id, state, wait_timeout, wait, validate_certs, enable_availability_zone, ec2_elbs

This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to. Returns fact "ec2_elbs" which is a list of elbs attached to the instance if state=absent is passed as an argument. Will be marked changed when called only if there are ELBs found to operate on.

Elb Network Lb *arguments

Manage a Network Load Balancer

Arguments: subnets, name, tags, purge_tags, listeners, deletion_protection, state, wait_timeout, purge_listeners, cross_zone_load_balancing, scheme, subnet_mappings, wait

Manage an AWS Network Elastic Load Balancer. See U(https://aws.amazon.com/blogs/aws/new-network-load-balancer-effortless-scaling-to-millions-of-requests-per-second/) for details.

Elb Target *arguments

Manage a target in a target group

Arguments: target_status_timeout, target_id, target_group_name, state, target_group_arn, target_port, target_status, deregister_unused, target_az

Used to register or deregister a target in a target group

Elb Target Group *arguments

Manage a target group for an Application or Network load balancer

Arguments: protocol, tags, purge_tags, health_check_port, successful_response_codes, wait_timeout, health_check_interval, modify_targets, healthy_threshold_count, targets, health_check_path, health_check_protocol, unhealthy_threshold_count, stickiness_type, name, target_type, port, stickiness_lb_cookie_duration, state, stickiness_enabled, vpc_id, deregistration_delay_timeout, wait, health_check_timeout

Manage an AWS Elastic Load Balancer target group. See U(https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) or U(https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-target-groups.html) for details.

Elb Target Group Info *arguments

Gather information about ELB target groups in AWS

Arguments: collect_targets_health, target_group_arns, load_balancer_arn, names

Gather information about ELB target groups in AWS This module was called C(elb_target_group_facts) before Ansible 2.9. The usage did not change.

Elb Target Info *arguments

Gathers which target groups a target is associated with.

Arguments: instance_id, get_unused_target_groups

This module will search through every target group in a region to find which ones have registered a given instance ID or IP. This module was called C(elb_target_facts) before Ansible 2.9. The usage did not change.

Emc Vnx Sg Member *arguments

Manage storage group member on EMC VNX

Arguments: state, lunid, name

This module manages the members of an existing storage group.

Enos Command *arguments

Run arbitrary commands on Lenovo ENOS devices

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an ENOS node and returns the results read from the device. The C(enos_command) module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Enos Config *arguments

Manage Lenovo ENOS configuration sections

Arguments: comment, src, backup_options, admin, config, after, lines, replace, parents, backup, match, before

Lenovo ENOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with ENOS configuration sections in a deterministic way.

Enos Facts *arguments

Collect facts from remote devices running Lenovo ENOS

Arguments: gather_subset

Collects a base set of device facts from a remote Lenovo device running on ENOS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Eos Banner *arguments

Manage multiline banners on Arista EOS devices

Arguments: text, state, banner

This will configure both login and motd banners on remote devices running Arista EOS. It allows playbooks to add or remote banner text from the active running configuration.

Eos Bgp *arguments

Configure global BGP protocol settings on Arista EOS.

Arguments: operation, config

This module provides configuration management of global BGP parameters on Arista EOS devices.

Eos Command *arguments

Run arbitrary commands on an Arista EOS device

Arguments: retries, commands, wait_for, match, interval

Sends an arbitrary set of commands to an EOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Eos Config *arguments

Manage Arista EOS configuration sections

Arguments: src, backup_options, after, lines, intended_config, diff_against, parents, save_when, defaults, before, running_config, replace, backup, match, diff_ignore_lines

Arista EOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with EOS configuration sections in a deterministic way. This module works with either CLI or eAPI transports.

Eos Eapi *arguments

Manage and configure Arista EOS eAPI.

Arguments: local_http_port, http_port, http, https_port, state, vrf, https, config, local_http, socket

Use to enable or disable eAPI access, and set the port and state of http, https, local_http and unix-socket servers. When enabling eAPI access the default is to enable HTTP on port 80, enable HTTPS on port 443, disable local HTTP, and disable Unix socket server. Use the options listed below to override the default configuration. Requires EOS v4.12 or greater.

Eos Facts *arguments

Collect facts from remote devices running Arista EOS

Arguments: gather_subset, gather_network_resources

Collects facts from Arista devices running the EOS operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Eos Interfaces *arguments

Manages interface attributes of Arista EOS interfaces

Arguments: state, config

This module manages the interface attributes of Arista EOS interfaces.

Eos L2 Interfaces *arguments

Manages Layer-2 interface attributes of Arista EOS devices

Arguments: state, config

This module provides declarative management of Layer-2 interface on Arista EOS devices.

Eos L3 Interfaces *arguments

Manages L3 interface attributes of Arista EOS devices.

Arguments: state, config

This module provides declarative management of Layer 3 interfaces on Arista EOS devices.

Eos Lacp *arguments

Manage Global Link Aggregation Control Protocol (LACP) on Arista EOS devices.

Arguments: state, config

This module manages Global Link Aggregation Control Protocol (LACP) on Arista EOS devices.

Eos Lacp Interfaces *arguments

Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on Arista EOS devices.

Arguments: state, config

This module manages Link Aggregation Control Protocol (LACP) attributes of interfaces on Arista EOS devices.

Eos Lag Interfaces *arguments

Manages link aggregation groups on Arista EOS devices

Arguments: state, config

This module manages attributes of link aggregation groups on Arista EOS devices.

Eos Lldp *arguments

Manage LLDP configuration on Arista EOS network devices

Arguments: state

This module provides declarative management of LLDP service on Arista EOS network devices.

Eos Lldp Global *arguments

Manage Global Link Layer Discovery Protocol (LLDP) settings on Arista EOS devices.

Arguments: state, config

This module manages Global Link Layer Discovery Protocol (LLDP) settings on Arista EOS devices.

Eos Lldp Interfaces *arguments

Manage Link Layer Discovery Protocol (LLDP) attributes of interfaces on Arista EOS devices.

Arguments: state, config

This module manages Link Layer Discovery Protocol (LLDP) attributes of interfaces on Arista EOS devices.

Eos Logging *arguments

Manage logging on network devices

Arguments: aggregate, state, name, level, dest, facility, size

This module provides declarative management of logging on Arista Eos devices.

Eos Static Route *arguments

Manage static IP routes on Arista EOS network devices

Arguments: state, next_hop, vrf, address, aggregate, admin_distance

This module provides declarative management of static IP routes on Arista EOS network devices.

Eos System *arguments

Manage the system attributes on Arista EOS devices

Arguments: state, lookup_source, name_servers, domain_search, hostname, domain_name

This module provides declarative management of node system attributes on Arista EOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Eos User *arguments

Manage the collection of local users on EOS devices

Arguments: update_password, configured_password, aggregate, name, purge, privilege, state, role, nopassword, sshkey

This module provides declarative management of the local usernames configured on Arista EOS devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Eos Vlans *arguments

Manage VLANs on Arista EOS devices.

Arguments: state, config

This module provides declarative management of VLANs on Arista EOS network devices.

Eos Vrf *arguments

Manage VRFs on Arista EOS network devices

Arguments: rd, name, interfaces, purge, associated_interfaces, state, delay, aggregate

This module provides declarative management of VRFs on Arista EOS network devices.

Eric Eccli Command *arguments

Run commands on remote devices running ERICSSON ECCLI

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an ERICSSON eccli node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module also support running commands in configuration mode in raw command style.

Etcd 3 *arguments

Set or delete key value pairs from an etcd3 cluster

Arguments: key, ca_cert, host, value, port, state, user, timeout, password, client_cert, client_key

Sets or deletes values in etcd3 cluster using its v3 api. Needs python etcd3 lib to work

Execute Lambda *arguments

Execute an AWS Lambda function

Arguments: version_qualifier, name, dry_run, function_arn, wait, payload, tail_log

This module executes AWS Lambda functions, allowing synchronous and asynchronous invocation.

Exo Dns Domain *arguments

Manages domain records on Exoscale DNS API.

Arguments: state, name

Create and remove domain records.

Exo Dns Record *arguments

Manages DNS records on Exoscale DNS.

Arguments: domain, multiple, name, prio, content, record_type, state, ttl

Create, update and delete records.

Exos Command *arguments

Run commands on remote devices running Extreme EXOS

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an Extreme EXOS device and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running configuration commands. Please use M(exos_config) to configure EXOS devices.

Exos Config *arguments

Manage Extreme Networks EXOS configuration sections

Arguments: src, backup_options, after, lines, intended_config, diff_against, running_config, save_when, defaults, before, replace, backup, match, diff_ignore_lines

Extreme EXOS configurations use a simple flat text file syntax. This module provides an implementation for working with EXOS configuration lines in a deterministic way.

Exos Facts *arguments

Collect facts from devices running Extreme EXOS

Arguments: gather_subset, gather_network_resources

Collects a base set of device facts from a remote device that is running EXOS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Exos Lldp Global *arguments

Configure and manage Link Layer Discovery Protocol(LLDP) attributes on EXOS platforms.

Arguments: state, config

This module configures and manages the Link Layer Discovery Protocol(LLDP) attributes on Extreme Networks EXOS platforms.

Expect *arguments

Executes a command and responds to prompts.

Arguments: creates, chdir, command, responses, timeout, removes, echo

The C(expect) module executes a command and responds to prompts. The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like C($HOME) and operations like C("<"), C(">"), C("|"), and C("&") will not work.

Facter *arguments

Runs the discovery program I(facter) on the remote system

Arguments:

Runs the I(facter) discovery program (U(https://github.com/puppetlabs/facter)) on the remote system, returning JSON data that can be useful for inventory purposes.

Fail *arguments

Fail with custom message

Arguments: msg

This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using C(when). This module is also supported for Windows targets.

Faz Device *arguments

Add or remove device

Arguments: device_username, os_minor_vers, adom, device_ip, device_password, device_unique_name, mode, faz_quota, mgmt_mode, device_serial, os_type, os_ver, platform_str

Add or remove a device or list of devices to FortiAnalyzer Device Manager. ADOM Capable.

Fetch *arguments

Fetch files from remote nodes

Arguments: dest, src, validate_checksum, fail_on_missing, flat

This module works like M(copy), but in reverse. It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname. Files that already exist at I(dest) will be overwritten if they are different than the I(src). This module is also supported for Windows targets.

File *arguments

Manage files and file properties

Arguments: src, force, access_time, recurse, access_time_format, modification_time, state, modification_time_format, path, follow

Set attributes of files, symlinks or directories. Alternatively, remove files, symlinks or directories. Many other modules support the same options as the C(file) module - including M(copy), M(template), and M(assemble). For Windows targets, use the M(win_file) module instead.

Filesystem *arguments

Makes a filesystem

Arguments: resizefs, force, dev, opts, fstype

This module creates a filesystem.

Find *arguments

Return a list of files based on specific criteria

Arguments: paths, excludes, file_type, age, contains, recurse, age_stamp, patterns, depth, get_checksum, use_regex, follow, hidden, size

Return a list of files based on specific criteria. Multiple criteria are AND'd together. For Windows targets, use the M(win_find) module instead.

Firewalld *arguments

Manage arbitrary ports/services with firewalld

Arguments: icmp_block_inversion, service, zone, masquerade, icmp_block, immediate, source, state, permanent, timeout, interface, offline, port, rich_rule

This module allows for addition or deletion of services and ports (either TCP or UDP) in either running or permanent firewalld rules.

Flatpak *arguments

Manage flatpaks

Arguments: executable, remote, state, name, method

Allows users to add or remove flatpaks. See the M(flatpak_remote) module for managing flatpak remotes.

Flatpak Remote *arguments

Manage flatpak repository remotes

Arguments: method, executable, state, flatpakrepo_url, name

Allows users to add or remove flatpak remotes. The flatpak remotes concept is comparable to what is called repositories in other packaging formats. Currently, remote addition is only supported via I(flatpakrepo) file URLs. Existing remotes will not be updated. See the M(flatpak) module for managing flatpaks.

Flowadm *arguments

Manage bandwidth resource control and priority for protocols, services and zones on Solaris/illumos systems

Arguments: dsfield, temporary, name, maxbw, local_port, local_ip, priority, state, link, transport, remote_ip

Create/modify/remove networking bandwidth and associated resources for a type of traffic on a particular link.

Flowdock *arguments

Send a message to a flowdock

Arguments: from_name, from_address, tags, type, external_user_name, project, source, token, link, reply_to, subject, validate_certs, msg

Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat)

Fmgr Device *arguments

Add or remove device from FortiManager.

Arguments: device_username, adom, blind_add, device_ip, device_unique_name, mode, device_serial, device_password

Add or remove a device or list of devices from FortiManager Device Manager using JSON RPC API.

Fmgr Device Config *arguments

Edit device configurations

Arguments: install_config, device_unique_name, adom, interface, device_hostname, interface_ip, interface_allow_access

Edit device configurations from FortiManager Device Manager using JSON RPC API.

Fmgr Device Group *arguments

Alter FortiManager device groups.

Arguments: grp_desc, mode, adom, grp_name, grp_members, vdom

Add or edit device groups and assign devices to device groups FortiManager Device Manager using JSON RPC API.

Fmgr Device Provision Template *arguments

Manages Device Provisioning Templates in FortiManager.

Arguments: snmp_v2c_query_status, dns_suffix, snmpv3_queries, snmpv3_trap_status, syslog_facility, snmp_v2c_status, ntp_server, ntp_status, ntp_auth, smtp_username, snmpv3_status, syslog_certificate, admin_fortiguard_target, snmpv3_query_port, adom, snmpv3_notify_hosts, snmp_v2c_trap_status, syslog_status, device_unique_name, snmp_v2c_trap_src_ipv4, snmp_v2c_query_hosts_ipv4, syslog_filter, snmpv3_source_ip, admin_gui_theme, provisioning_template, ntp_v3, provision_targets, snmp_v2c_trap_port, mode, delete_provisioning_template, snmp_v2c_trap_hosts_ipv4, snmpv3_security_level, ntp_type, admin_https_port, syslog_mode, snmp_v2c_name, syslog_port, snmpv3_name, smtp_validate_cert, smtp_conn_sec, syslog_server, admin_switch_controller, admin_timeout, snmpv3_auth_proto, smtp_port, snmpv3_priv_pwd, smtp_server, syslog_enc_algorithm, smtp_password, snmp_v2c_query_port, admin_http_port, snmp_status, snmp_v2c_id, dns_secondary_ipv4, snmpv3_trap_rport, ntp_sync_interval, ntp_auth_pwd, smtp_replyto, snmpv3_priv_proto, admin_enable_fortiguard, dns_primary_ipv4, admin_language, snmpv3_auth_pwd, admin_fortianalyzer_target, smtp_source_ipv4, admin_https_redirect

Allows the editing and assignment of device provisioning templates in FortiManager.

Fmgr Fwobj Address *arguments

Allows the management of firewall objects in FortiManager

Arguments: comment, allow_routing, wildcard, adom, color, visibility, group_name, start_ip, cache_ttl, fqdn, name, obj_id, country, ipv4addr, wildcard_fqdn, group_members, end_ip, ipv4, multicast, ipv6, ipv6addr, associated_interface, mode

Allows for the management of IPv4, IPv6, and multicast address objects within FortiManager.

Fmgr Fwobj Ippool *arguments

Allows the editing of IP Pool Objects within FortiManager.

Arguments: dynamic_mapping_endip, dynamic_mapping_permit_any_host, endip, arp_intf, dynamic_mapping_comments, dynamic_mapping, dynamic_mapping_associated_interface, dynamic_mapping_type, arp_reply, pba_timeout, dynamic_mapping_arp_reply, block_size, num_blocks_per_user, dynamic_mapping_num_blocks_per_user, permit_any_host, dynamic_mapping_startip, source_startip, name, dynamic_mapping_pba_timeout, startip, source_endip, adom, dynamic_mapping_block_size, comments, dynamic_mapping_source_endip, dynamic_mapping_arp_intf, dynamic_mapping_source_startip, type, associated_interface, mode

Allows users to add/edit/delete IP Pool Objects.

Fmgr Fwobj Ippool6 *arguments

Allows the editing of IP Pool Objects within FortiManager.

Arguments: dynamic_mapping_endip, endip, dynamic_mapping, name, dynamic_mapping_comments, startip, adom, comments, mode, dynamic_mapping_startip

Allows users to add/edit/delete IPv6 Pool Objects.

Fmgr Fwobj Service *arguments

Manages FortiManager Firewall Service Objects.

Arguments: comment, icmp_code, adom, protocol, custom_type, color, object_type, app_category, session_ttl, group_name, app_service_type, visibility, tcp_timewait_timer, icmp_type, iprange, group_member, name, category, sctp_portrange, explicit_proxy, tcp_portrange, tcp_halfclose_timer, udp_portrange, protocol_number, fqdn, tcp_halfopen_timer, application, mode, udp_idle_timer, check_reset_range

Manages FortiManager Firewall Service Objects.

Fmgr Fwobj Vip *arguments

Manages Virtual IPs objects in FortiManager

Arguments: ssl_mode, realservers_holddown_interval, dynamic_mapping_ssl_certificate, dynamic_mapping_nat_source_vip, ssl_client_session_state_type, mappedip, dynamic_mapping_ssl_server_session_state_max, protocol, dynamic_mapping_ssl_server_session_state_type, ssl_hsts_age, dynamic_mapping_ssl_dh_bits, dynamic_mapping_mapped_addr, max_embryonic_connections, dynamic_mapping_ssl_algorithm, dynamic_mapping_src_filter, extaddr, monitor, ssl_hpkp, ssl_http_match_host, ssl_hpkp_age, color, ssl_hsts_include_subdomains, websphere_server, dynamic_mapping_ssl_http_match_host, dynamic_mapping_ssl_min_version, dynamic_mapping_ssl_hpkp_report_uri, realservers_http_host, dynamic_mapping_realservers_monitor, dynamic_mapping_ssl_mode, dynamic_mapping_ssl_max_version, http_cookie_age, gratuitous_arp_interval, dynamic_mapping_http_cookie_domain_from_host, dynamic_mapping_ssl_hpkp_primary, name, realservers_port, dynamic_mapping_service, dynamic_mapping_ssl_client_renegotiation, mode, outlook_web_access, dynamic_mapping_ssl_hpkp, http_ip_header_name, dynamic_mapping_extintf, dynamic_mapping_realservers_ip, dynamic_mapping_realservers_seq, dynamic_mapping_ssl_hpkp_age, dynamic_mapping_extip, dns_mapping_ttl, dynamic_mapping_ssl_server_min_version, realservers_ip, dynamic_mapping_comment, dynamic_mapping_arp_reply, portforward, ssl_http_location_conversion, ssl_algorithm, dynamic_mapping_extaddr, ssl_hpkp_include_subdomains, dynamic_mapping_ssl_server_session_state_timeout, ssl_dh_bits, ssl_server_cipher_suites_versions, dynamic_mapping_ssl_hsts, ssl_server_cipher_suites_cipher, ssl_client_renegotiation, ssl_server_cipher_suites_priority, ssl_min_version, dynamic_mapping, server_type, dynamic_mapping_http_ip_header_name, dynamic_mapping_realservers_port, dynamic_mapping_realservers_max_connections, dynamic_mapping_websphere_server, dynamic_mapping_http_cookie_domain, dynamic_mapping_srcintf_filter, portmapping_type, ssl_pfs, ssl_cipher_suites, dynamic_mapping_ssl_pfs, dynamic_mapping_ssl_hsts_age, weblogic_server, dynamic_mapping_weblogic_server, dynamic_mapping_http_cookie_age, realservers_seq, ssl_server_algorithm, ssl_server_session_state_type, dynamic_mapping_extport, comment, dynamic_mapping_protocol, dynamic_mapping_realservers_http_host, dynamic_mapping_mappedport, ssl_server_min_version, http_cookie_generation, http_cookie_domain, http_multiplex, dynamic_mapping_http_multiplex, dynamic_mapping_ssl_client_fallback, dynamic_mapping_portforward, dynamic_mapping_monitor, ssl_hpkp_report_uri, dynamic_mapping_mappedip, ssl_hsts, dynamic_mapping_color, service, persistence, dynamic_mapping_http_cookie_path, type, src_filter, http_ip_header, dynamic_mapping_ssl_hpkp_backup, realservers_monitor, dynamic_mapping_ssl_cipher_suites_cipher, adom, https_cookie_secure, dynamic_mapping_ldb_method, extport, ssl_server_session_state_max, dynamic_mapping_realservers_healthcheck, dynamic_mapping_ssl_send_empty_frags, ssl_cipher_suites_versions, dynamic_mapping_ssl_cipher_suites_versions, dynamic_mapping_realservers_client_ip, ssl_send_empty_frags, dynamic_mapping_ssl_client_session_state_type, ssl_client_session_state_max, dynamic_mapping_realservers_holddown_interval, ssl_certificate, dynamic_mapping_dns_mapping_ttl, arp_reply, ldb_method, dynamic_mapping_gratuitous_arp_interval, ssl_client_fallback, dynamic_mapping_max_embryonic_connections, ssl_hpkp_backup, dynamic_mapping_ssl_server_algorithm, http_cookie_domain_from_host, ssl_hpkp_primary, dynamic_mapping_server_type, dynamic_mapping_outlook_web_access, dynamic_mapping_type, dynamic_mapping_http_cookie_generation, ssl_max_version, extip, nat_source_vip, dynamic_mapping_ssl_hpkp_include_subdomains, dynamic_mapping_ssl_server_max_version, realservers_weight, ssl_cipher_suites_cipher, realservers_client_ip, dynamic_mapping_http_ip_header, dynamic_mapping_persistence, ssl_server_cipher_suites, dynamic_mapping_portmapping_type, extintf, dynamic_mapping_ssl_client_session_state_max, realservers_max_connections, ssl_server_session_state_timeout, dynamic_mapping_ssl_client_session_state_timeout, ssl_client_session_state_timeout, realservers_healthcheck, dynamic_mapping_realservers_weight, http_cookie_path, mapped_addr, mappedport, dynamic_mapping_ssl_http_location_conversion, dynamic_mapping_ssl_hsts_include_subdomains, realservers, srcintf_filter, http_cookie_share, realservers_status, dynamic_mapping_realservers_status, dynamic_mapping_https_cookie_secure, ssl_server_max_version, dynamic_mapping_http_cookie_share

Manages Virtual IP objects in FortiManager for IPv4

Fmgr Fwpol Ipv4 *arguments

Allows the add/delete of Firewall Policies on Packages in FortiManager.

Arguments: per_ip_shaper, package_name, learning_mode, dscp_match, diffserv_reverse, traffic_shaper_reverse, dlp_sensor, ssl_mirror, identity_based_route, vpn_src_node_host, custom_log_fields, internet_service_src_negate, natip, voip_profile, np_acceleration, name, internet_service_id, ntlm, natoutbound, mode, vpn_dst_node_seq, internet_service, internet_service_src, spamfilter_profile, ssh_filter_profile, vlan_cos_rev, tcp_session_without_syn, url_category, session_ttl, mms_profile, internet_service_negate, auth_redirect_addr, poolname, ssl_ssh_profile, internet_service_src_custom, comments, label, wanopt, capture_packet, app_category, profile_type, schedule, wanopt_profile, diffservcode_rev, tcp_mss_sender, dstintf, groups, ssl_mirror_intf, dscp_negate, waf_profile, scan_botnet_connections, vpn_dst_node_host, match_vip, vlan_filter, srcintf, redirect_url, action, disclaimer, gtp_profile, srcaddr_negate, icap_profile, application_list, service_negate, send_deny_packet, fsso_agent_for_ntlm, webcache, vpn_src_node, ippool, service, wccp, permit_stun_host, dnsfilter_profile, profile_group, delay_tcp_npu_session, tcp_mss_receiver, ntlm_enabled_browsers, logtraffic, global_label, adom, inbound, srcaddr, block_notification, webfilter_profile, vpn_src_node_seq, permit_any_host, logtraffic_start, webcache_https, ips_sensor, devices, radius_mac_auth_bypass, internet_service_src_id, schedule_timeout, ntlm_guest, rsso, traffic_shaper, captive_portal_exempt, diffserv_forward, wanopt_detection, auth_cert, vpn_src_node_subnet, internet_service_custom, natinbound, rtp_addr, vlan_cos_fwd, fixedport, dsri, wanopt_passive_opt, outbound, vpn_dst_node, rtp_nat, application, vpn_dst_node_subnet, nat, timeout_send_rst, fsso, status, diffservcode_forward, users, dscp_value, utm_status, auto_asic_offload, policyid, firewall_session_dirty, wanopt_peer, replacemsg_override_group, dstaddr_negate, av_profile, profile_protocol_options, auth_path, wsso, dstaddr, app_group, fail_on_missing_dependency, vpntunnel

Allows the add/delete of Firewall Policies on Packages in FortiManager.

Fmgr Fwpol Package *arguments

Manages FortiManager Firewall Policies Packages.

Arguments: object_type, name, adom, ngfw_mode, ssl_ssh_profile, central_nat, fwpolicy_implicit_log, scope_members, mode, package_folder, parent_folder, scope_members_vdom, fwpolicy6_implicit_log, inspection_mode

Manages FortiManager Firewall Policies Packages. Policy Packages contain one or more Firewall Policies/Rules and are distritbuted via FortiManager to Fortigates. This module controls the creation/edit/delete/assign of these packages.

Fmgr Ha *arguments

Manages the High-Availability State of FortiManager Clusters and Nodes.

Arguments: fmgr_ha_peer_sn, fmgr_ha_hb_threshold, fmgr_ha_cluster_pw, fmgr_ha_peer_ipv6, fmgr_ha_peer_status, fmgr_ha_file_quota, fmgr_ha_cluster_id, fmgr_ha_peer_ipv4, fmgr_ha_hb_interval, fmgr_ha_mode

Change HA state or settings of FortiManager nodes (Standalone/Master/Slave).

Fmgr Provisioning *arguments

Provision devices via FortiMananger

Arguments: username, group, name, adom, patch_release, os_version, host, minor_release, platform, policy_package, serial, password, os_type, vdom, description

Add model devices on the FortiManager using jsonrpc API and have them pre-configured, so when central management is configured, the configuration is pushed down to the registering devices

Fmgr Query *arguments

Query FortiManager data objects for use in Ansible workflows.

Arguments: custom_endpoint, object, task_id, adom, device_ip, custom_dict, device_unique_name, nodes, device_serial

Provides information on data objects within FortiManager so that playbooks can perform conditionals.

Fmgr Script *arguments

Add/Edit/Delete and execute scripts

Arguments: script_content, adom, script_scope, script_name, script_target, mode, script_description, script_package, vdom, script_type

Create/edit/delete scripts and execute the scripts on the FortiManager using jsonrpc API

Fmgr Secprof Appctrl *arguments

Manage application control security profiles

Arguments: comment, entries_popularity, entries_log, extended_log, deep_app_inspection, entries_quarantine_log, entries_protocols, entries_rate_mode, entries_shaper, entries_action, replacemsg_group, unknown_application_log, unknown_application_action, entries_quarantine, entries_category, adom, entries_application, app_replacemsg, other_application_log, entries_behavior, entries_vendor, entries_per_ip_shaper, mode, entries_rate_count, entries_risk, entries_log_packet, entries_quarantine_expiry, entries_sub_category, entries, entries_technology, name, other_application_action, p2p_black_list, entries_parameters_value, entries_session_ttl, entries_rate_track, entries_shaper_reverse, options, entries_rate_duration

Manage application control security profiles within FortiManager

Fmgr Secprof Av *arguments

Manage security profile

Arguments: comment, pop3_executables, smtp_emulator, http_archive_log, content_disarm_pdf_act_gotor, content_disarm_pdf_embedfile, smtp_options, content_disarm_office_macro, mapi_outbreak_prevention, replacemsg_group, smb_archive_block, analytics_bl_filetype, mapi_archive_log, content_disarm_office_embed, http_options, http_outbreak_prevention, smtp_archive_block, imap_archive_log, http_archive_block, content_disarm_office_linked, content_disarm_pdf_act_sound, http_emulator, imap_outbreak_prevention, content_disarm_pdf_act_movie, smtp_content_disarm, analytics_wl_filetype, content_disarm_original_file_destination, adom, nac_quar, smtp_archive_log, pop3, smb_options, nntp_archive_log, imap, nac_quar_expiry, nntp_archive_block, name, content_disarm_pdf_act_launch, mobile_malware_db, content_disarm_pdf_act_java, mode, content_disarm_cover_page, http_content_disarm, imap_archive_block, nntp_options, content_disarm_detect_only, smtp_executables, pop3_outbreak_prevention, mapi_archive_block, smtp_outbreak_prevention, smb_emulator, imap_options, imap_content_disarm, smtp, analytics_db, ftp_options, av_virus_log, pop3_content_disarm, mapi_executables, nac_quar_infected, mapi, ftp, ftp_emulator, nac_quar_log, pop3_emulator, analytics_max_upload, mapi_emulator, imap_executables, extended_log, content_disarm, pop3_options, smb_archive_log, nntp, smb, content_disarm_pdf_act_form, content_disarm_office_hylink, http, imap_emulator, ftp_outbreak_prevention, nntp_emulator, mapi_options, smb_outbreak_prevention, pop3_archive_log, content_disarm_pdf_hyperlink, ftgd_analytics, scan_mode, av_block_log, nntp_outbreak_prevention, ftp_archive_block, pop3_archive_block, ftp_archive_log, content_disarm_pdf_javacode, inspection_mode

Manage security profile groups for FortiManager objects

Fmgr Secprof Dns *arguments

Manage DNS security profiles in FortiManager

Arguments: comment, domain_filter_domain_filter_table, youtube_restrict, adom, safe_search, block_botnet, redirect_portal, ftgd_dns_options, sdns_domain_log, external_ip_blocklist, name, log_all_domain, ftgd_dns_filters_action, sdns_ftgd_err_log, block_action, mode, ftgd_dns_filters_log, ftgd_dns_filters_category

Manage DNS security profiles in FortiManager

Fmgr Secprof Ips *arguments

Managing IPS security profiles in FortiManager

Arguments: comment, override_status, override_exempt_ip_dst_ip, filter_os, entries_log, entries_application, replacemsg_group, override_exempt_ip_src_ip, entries_quarantine_log, entries_rate_mode, block_malicious_url, entries_action, filter_log, entries_rate_track, entries_protocol, entries_quarantine, entries_exempt_ip_dst_ip, entries_exempt_ip_src_ip, filter_quarantine, adom, extended_log, override_log_packet, entries_severity, override_log, override_quarantine_expiry, override_action, entries_log_attack_context, entries_rule, filter_severity, override, entries_os, override_quarantine, filter_quarantine_log, entries_rate_count, override_rule_id, entries_log_packet, entries_quarantine_expiry, filter_protocol, filter_status, filter_name, filter_quarantine_expiry, filter_action, entries_status, name, filter_application, entries_location, override_quarantine_log, filter, filter_log_packet, mode, entries, filter_location, entries_rate_duration

Managing IPS security profiles in FortiManager

Fmgr Secprof Profile Group *arguments

Manage security profiles within FortiManager

Arguments: spamfilter_profile, adom, application_list, av_profile, waf_profile, mms_profile, voip_profile, webfilter_profile, name, dlp_sensor, ssl_ssh_profile, ips_sensor, dnsfilter_profile, mode, icap_profile, profile_protocol_options, ssh_filter_profile

Manage security profile group which allows you to create a group of security profiles and apply that to a policy.

Fmgr Secprof Proxy *arguments

Manage proxy security profiles in FortiManager

Arguments: adom, header_x_authenticated_user, log_header_change, headers_name, header_x_forwarded_for, header_front_end_https, header_via_response, headers_content, headers_action, header_x_authenticated_groups, name, header_client_ip, strip_encoding, headers, mode, header_via_request

Manage proxy security profiles for FortiGates via FortiManager using the FMG API with playbooks

Fmgr Secprof Spam *arguments

spam filter profile for FMG

Arguments: comment, spam_bword_threshold, spam_iptrust_table, spam_log_fortiguard_response, mapi_log, msn_hotmail_log, replacemsg_group, imap_tag_msg, gmail, smtp_hdrip, smtp_log, spam_mheader_table, spam_rbl_table, mapi, spam_bword_table, yahoo_mail, gmail_log, yahoo_mail_log, spam_log, smtp_tag_msg, flow_based, adom, smtp, smtp_action, pop3_log, pop3, external, smtp_local_override, imap, imap_tag_type, name, msn_hotmail, pop3_tag_type, imap_log, spam_filtering, pop3_tag_msg, imap_action, pop3_action, mode, smtp_tag_type, options, spam_bwl_table, mapi_action

Manage spam filter security profiles within FortiManager via API

Fmgr Secprof Ssl Ssh *arguments

Manage SSL and SSH security profiles in FortiManager

Arguments: untrusted_caname, comment, pop3s_allow_invalid_server_cert, ftps_untrusted_cert, whitelist, caname, ftps, ftps_ports, imaps_untrusted_cert, https_allow_invalid_server_cert, ssl_server_ftps_client_cert_request, imaps_ports, smtps_status, ssh_unsupported_version, https, imaps, ssl_exempt_address6, ssl_server_imaps_client_cert_request, server_cert, ftps_allow_invalid_server_cert, adom, https_status, imaps_client_cert_request, smtps_untrusted_cert, pop3s_client_cert_request, ssl_inspect_all, ssl, ssh, ssl_exempt_address, smtps_allow_invalid_server_cert, name, ssl_exempt_type, ssl_exempt, ftps_status, ssh_ssh_tun_policy_check, ssh_inspect_all, mode, ftps_unsupported_ssl, imaps_status, ssh_ports, rpc_over_https, ssl_server_smtps_client_cert_request, ssl_server_ssl_other_client_cert_request, pop3s, ssl_allow_invalid_server_cert, use_ssl_server, server_cert_mode, https_ports, pop3s_ports, https_client_cert_request, smtps_client_cert_request, https_untrusted_cert, imaps_allow_invalid_server_cert, pop3s_unsupported_ssl, ssh_ssh_algorithm, ssl_exempt_regex, imaps_unsupported_ssl, ssl_client_cert_request, mapi_over_https, ssl_exempt_wildcard_fqdn, ftps_client_cert_request, ssl_server, https_unsupported_ssl, ssl_server_ip, ssl_server_https_client_cert_request, smtps_ports, ssh_ssh_policy_check, ssl_exempt_fortiguard_category, ssl_exemptions_log, ssl_untrusted_cert, ssl_unsupported_ssl, smtps, ssl_server_pop3s_client_cert_request, ssh_status, pop3s_status, pop3s_untrusted_cert, ssl_anomalies_log, smtps_unsupported_ssl

Manage SSL and SSH security profiles in FortiManager via the FMG API

Fmgr Secprof Voip *arguments

VOIP security profiles in FMG

Arguments: comment, sip_ssl_client_certificate, sip_malformed_header_rseq, sccp_status, sip_provisional_invite_expiry_time, sip_open_register_pinhole, sip_malformed_header_max_forwards, sip_malformed_header_cseq, sccp, sip_block_register, sip_block_invite, sip_max_dialogs, sip_status, sip_open_contact_pinhole, sip_block_notify, sip_malformed_header_expires, sip_ssl_send_empty_frags, sip_block_geo_red_options, sip_ssl_mode, sccp_verify_header, sip_rfc2543_branch, sip_block_subscribe, sip_message_rate, sip_max_body_length, sip_hosted_nat_traversal, sccp_log_violations, sip_notify_rate, sip_log_violations, sip_call_keepalive, sip_malformed_header_content_type, sip_register_rate, sip_cancel_rate, adom, sip_bye_rate, sip_block_info, sip_subscribe_rate, sip_hnt_restrict_source_ip, sip_malformed_header_call_id, sip_malformed_header_p_asserted_identity, sip_ssl_auth_server, sip_block_options, sccp_max_calls, sip_nat_trace, sip_block_unknown, sip_publish_rate, sip_block_prack, sip_malformed_request_line, name, sip_no_sdp_fixup, sip_block_update, sip_malformed_header_content_length, sip_open_via_pinhole, sip_block_refer, sip_preserve_override, mode, sip_ssl_client_renegotiation, sip_ack_rate, sip_contact_fixup, sip_ssl_min_version, sip_block_message, sip_options_rate, sip_block_ack, sip_malformed_header_to, sip_unknown_header, sip_update_rate, sip_block_long_lines, sip_malformed_header_sdp_k, sip_malformed_header_allow, sip_register_contact_trace, sip_malformed_header_record_route, sip_block_bye, sip, sip_malformed_header_sdp_i, sip_malformed_header_sdp_s, sccp_log_call_summary, sip_refer_rate, sip_strict_register, sip_invite_rate, sip_log_call_summary, sip_prack_rate, sip_open_record_route_pinhole, sip_malformed_header_sdp_o, sip_malformed_header_sdp_m, sip_max_line_length, sip_ssl_max_version, sip_info_rate, sip_malformed_header_sdp_c, sip_malformed_header_sdp_b, sip_malformed_header_sdp_a, sip_malformed_header_from, sip_malformed_header_sdp_z, sip_malformed_header_contact, sip_ssl_algorithm, sip_malformed_header_sdp_v, sip_max_idle_dialogs, sip_malformed_header_sdp_t, sip_ssl_pfs, sip_malformed_header_sdp_r, sip_block_cancel, sccp_block_mcast, sip_ssl_server_certificate, sip_malformed_header_via, sip_malformed_header_rack, sip_block_publish, sip_ips_rtp, sip_rtp, sip_ssl_auth_client, sip_malformed_header_route

Manage VOIP security profiles in FortiManager via API

Fmgr Secprof Waf *arguments

FortiManager web application firewall security profile

Arguments: method_method_policy_allowed_methods, comment, constraint_url_param_length_status, constraint_param_length_status, constraint_malformed_status, constraint_method_status, signature_main_class_severity, constraint_param_length_length, constraint_max_header_line_severity, constraint_url_param_length_length, url_access_log, url_access_access_pattern_pattern, signature_custom_signature_log, constraint_header_length_action, constraint_max_range_segment_log, constraint_line_length_status, constraint_max_header_line_action, constraint_max_range_segment_max_range_segment, constraint_line_length_length, constraint_max_cookie_severity, address_list_blocked_address, constraint_exception_hostname, signature_custom_signature_target, constraint_max_range_segment_status, constraint_max_header_line_status, constraint_exception_param_length, constraint_content_length_severity, constraint_line_length_action, address_list, address_list_blocked_log, constraint_param_length_log, constraint_max_url_param_log, constraint_exception_version, adom, constraint_max_header_line_log, constraint_max_url_param_action, constraint_param_length_action, constraint_url_param_length_severity, constraint_line_length_log, url_access, address_list_status, constraint_version_action, address_list_trusted_address, signature_main_class_status, method_log, constraint_exception_line_length, constraint_hostname_severity, name, constraint_method_action, constraint_header_length_severity, constraint_hostname_log, constraint_max_cookie_max_cookie, constraint_exception_max_cookie, constraint_content_length_action, constraint_header_length_log, constraint_param_length_severity, constraint_max_url_param_severity, constraint_max_range_segment_action, constraint_max_cookie_status, constraint_max_url_param_status, constraint_version_severity, constraint_exception_max_range_segment, method_method_policy_pattern, method_severity, constraint_max_range_segment_severity, mode, url_access_action, constraint_method_severity, signature_credit_card_detection_threshold, constraint_version_status, signature_custom_signature_case_sensitivity, constraint_content_length_status, signature_custom_signature_status, constraint_max_cookie_log, url_access_severity, signature_main_class_log, signature_custom_signature_direction, address_list_severity, extended_log, url_access_access_pattern_regex, signature_custom_signature_pattern, signature_custom_signature_name, signature_main_class_action, signature_custom_signature_severity, constraint_content_length_length, constraint_exception_malformed, constraint_malformed_action, method, constraint_malformed_severity, url_access_address, constraint_exception_header_length, method_method_policy_address, constraint_exception_pattern, method_status, method_method_policy_regex, constraint_method_log, constraint_max_url_param_max_url_param, constraint_url_param_length_log, constraint_exception_max_url_param, constraint_max_cookie_action, constraint_exception_address, constraint_exception_content_length, constraint_malformed_log, constraint_exception_method, constraint_max_header_line_max_header_line, url_access_access_pattern_negate, constraint_hostname_action, signature_disabled_sub_class, constraint_content_length_log, constraint_version_log, signature_disabled_signature, constraint, signature_custom_signature_action, constraint_url_param_length_action, url_access_access_pattern_srcaddr, method_default_allowed_methods, constraint_header_length_length, constraint_exception_url_param_length, constraint_header_length_status, constraint_exception_regex, constraint_hostname_status, signature, constraint_line_length_severity, constraint_exception_max_header_line, external

Manage web application firewall security profiles for FGTs via FMG

Fmgr Secprof Wanopt *arguments

WAN optimization

Arguments: cifs_byte_caching, auth_group, ftp_status, http_tunnel_sharing, http_tunnel_non_http, ftp_byte_caching, tcp_ssl, tcp, http_ssl, comments, cifs_secure_tunnel, ftp_tunnel_sharing, ftp, http_port, http_status, tcp_port, mapi, tcp_secure_tunnel, http_ssl_port, cifs_prefer_chunking, mapi_port, tcp_status, ftp_log_traffic, http, cifs, http_byte_caching, adom, tcp_ssl_port, http_unknown_http_version, tcp_log_traffic, cifs_port, tcp_tunnel_sharing, mapi_status, tcp_byte_caching, ftp_prefer_chunking, cifs_log_traffic, ftp_secure_tunnel, mapi_byte_caching, transparent, name, ftp_port, http_log_traffic, mapi_log_traffic, http_prefer_chunking, cifs_tunnel_sharing, http_secure_tunnel, mapi_secure_tunnel, cifs_status, mode, tcp_byte_caching_opt, mapi_tunnel_sharing

Manage WanOpt security profiles in FortiManager via API

Fmgr Secprof Web *arguments

Manage web filter security profiles in FortiManager

Arguments: web_filter_applet_log, comment, override_ovrd_dur_mode, ftgd_wf_filters_warning_prompt, web_filter_referer_log, web_filter_activex_log, ftgd_wf_quota_category, web_filter_jscript_log, web_url_log, url_extraction_redirect_header, url_extraction_redirect_no_content, replacemsg_group, web_filter_unknown_log, web_filter_cookie_removal_log, wisp_algorithm, ftgd_wf_quota_duration, web_filter_command_block_log, web_bword_table, ftgd_wf_filters_auth_usr_grp, override_ovrd_cookie, web_keyword_match, override, ftgd_wf_quota_type, ftgd_wf_rate_css_urls, override_profile, url_extraction_server_fqdn, wisp_servers, web_ftgd_quota_usage, post_action, web_urlfilter_table, web_filter_vbs_log, web_bword_threshold, override_profile_attribute, ftgd_wf_filters_log, name, ftgd_wf_filters_override_replacemsg, wisp, mode, youtube_channel_filter, override_ovrd_scope, ftgd_wf_rate_crl_urls, log_all_url, ftgd_wf_filters_warn_duration, ftgd_wf_exempt_quota, override_ovrd_dur, web_log_search, ftgd_wf_ovrd, web_content_header_list, ovrd_perm, override_ovrd_user_group, web_safe_search, ftgd_wf_filters_category, ftgd_wf_options, ftgd_wf_filters_warning_duration_type, web_filter_js_log, url_extraction_status, ftgd_wf_quota_override_replacemsg, youtube_channel_filter_comment, adom, extended_log, youtube_channel_status, ftgd_wf_rate_image_urls, web_filter_cookie_log, web_blacklist, web_content_log, web_ftgd_err_log, web_youtube_restrict, override_profile_type, web, ftgd_wf, ftgd_wf_filters_action, web_whitelist, url_extraction_redirect_url, youtube_channel_filter_channel_id, ftgd_wf_quota_value, web_invalid_domain_log, ftgd_wf_rate_javascript_urls, ftgd_wf_max_quota_timeout, ftgd_wf_quota_unit, url_extraction, https_replacemsg, web_extended_all_action_log, options, inspection_mode

Manage web filter security profiles in FortiManager through playbooks using the FMG API

Fortios Address *arguments

Manage fortios firewall address objects

Arguments: comment, name, country, value, start_ip, state, end_ip, interface, type

This module provide management of firewall addresses on FortiOS devices.

Fortios Alertemail Setting *arguments

Configure alert email settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, alertemail_setting, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify alertemail feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Antivirus Heuristic *arguments

Configure global heuristic options in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, antivirus_heuristic, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify antivirus feature and heuristic category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Antivirus Profile *arguments

Configure AntiVirus profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, antivirus_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify antivirus feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Antivirus Quarantine *arguments

Configure quarantine options in Fortinet's FortiOS and FortiGate.

Arguments: username, antivirus_quarantine, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify antivirus feature and quarantine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Antivirus Settings *arguments

Configure AntiVirus settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, antivirus_settings, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify antivirus feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Application Custom *arguments

Configure custom application signatures in Fortinet's FortiOS and FortiGate.

Arguments: username, state, ssl_verify, application_custom, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Application Group *arguments

Configure firewall application groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, application_group, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Application List *arguments

Configure application control lists in Fortinet's FortiOS and FortiGate.

Arguments: username, application_list, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Application Name *arguments

Configure application signatures in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, application_name, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and name category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Application Rule Settings *arguments

Configure application rule settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, application_rule_settings, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify application feature and rule_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Authentication Rule *arguments

Configure Authentication Rules in Fortinet's FortiOS and FortiGate.

Arguments: username, host, authentication_rule, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify authentication feature and rule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Authentication Scheme *arguments

Configure Authentication Schemes in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, authentication_scheme, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify authentication feature and scheme category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Authentication Setting *arguments

Configure authentication setting in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, authentication_setting, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify authentication feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Config *arguments

Manage config on Fortinet FortiOS firewall devices

Arguments: filter, src

This module provides management of FortiOS Devices configuration.

Fortios Dlp Filepattern *arguments

Configure file patterns used by DLP blocking in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vdom, https, ssl_verify, password, dlp_filepattern

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and filepattern category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Dlp Fp Doc Source *arguments

Create a DLP fingerprint database by allowing the FortiGate to access a file server containing files from which to create fingerprints in Fortinet's FortiOS and FortiGate.

Arguments: username, host, dlp_fp_doc_source, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and fp_doc_source category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Dlp Fp Sensitivity *arguments

Create self-explanatory DLP sensitivity levels to be used when setting sensitivity under config fp-doc-source in Fortinet's FortiOS and FortiGate.

Arguments: username, host, dlp_fp_sensitivity, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and fp_sensitivity category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Dlp Sensor *arguments

Configure DLP sensors in Fortinet's FortiOS and FortiGate.

Arguments: username, dlp_sensor, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and sensor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Dlp Settings *arguments

Designate logical storage for DLP fingerprint database in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, dlp_settings, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dlp feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Dnsfilter Domain Filter *arguments

Configure DNS domain filters in Fortinet's FortiOS and FortiGate.

Arguments: username, dnsfilter_domain_filter, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dnsfilter feature and domain_filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Dnsfilter Profile *arguments

Configure DNS domain filter profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, dnsfilter_profile, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify dnsfilter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Endpoint Control Client *arguments

Configure endpoint control client lists in Fortinet's FortiOS and FortiGate.

Arguments: username, state, ssl_verify, endpoint_control_client, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify endpoint_control feature and client category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Endpoint Control Forticlient Ems *arguments

Configure FortiClient Enterprise Management Server (EMS) entries in Fortinet's FortiOS and FortiGate.

Arguments: username, endpoint_control_forticlient_ems, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify endpoint_control feature and forticlient_ems category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Endpoint Control Forticlient Registration Sync *arguments

Configure FortiClient registration synchronization settings in Fortinet's FortiOS and FortiGate.

Arguments: username, endpoint_control_forticlient_registration_sync, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify endpoint_control feature and forticlient_registration_sync category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Endpoint Control Profile *arguments

Configure FortiClient endpoint control profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, host, endpoint_control_profile, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify endpoint_control feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Endpoint Control Settings *arguments

Configure endpoint control settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, endpoint_control_settings, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify endpoint_control feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Extender Controller Extender *arguments

Extender controller configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, extender_controller_extender, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify extender_controller feature and extender category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Facts *arguments

Get facts about fortios devices.

Arguments: username, host, gather_subset, https, ssl_verify, password, vdom

Collects facts from network devices running the fortios operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. This facts module will only collect those facts which user specified in playbook.

Fortios Firewall Address *arguments

Configure IPv4 addresses in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, firewall_address, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Address6 *arguments

Configure IPv6 firewall addresses in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, firewall_address6, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Address6 Template *arguments

Configure IPv6 address templates in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_address6_template, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and address6_template category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Addrgrp *arguments

Configure IPv4 address groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, firewall_addrgrp

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and addrgrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Addrgrp6 *arguments

Configure IPv6 address groups in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_addrgrp6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and addrgrp6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Auth Portal *arguments

Configure firewall authentication portals in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, firewall_auth_portal

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and auth_portal category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Central Snat Map *arguments

Configure central SNAT policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, firewall_central_snat_map, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and central_snat_map category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Dnstranslation *arguments

Configure DNS translation in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_dnstranslation, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and dnstranslation category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall DoS Policy *arguments

Configure IPv4 DoS policies in Fortinet's FortiOS and FortiGate.

Arguments: username, password, host, state, https, ssl_verify, firewall_DoS_policy, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and DoS_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall DoS Policy6 *arguments

Configure IPv6 DoS policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, firewall_DoS_policy6, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and DoS_policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Identity Based Route *arguments

Configure identity based routing in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_identity_based_route, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and identity_based_route category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Interface Policy *arguments

Configure IPv4 interface policies in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_interface_policy, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and interface_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Interface Policy6 *arguments

Configure IPv6 interface policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, firewall_interface_policy6, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and interface_policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Internet Service *arguments

Show Internet Service application in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_internet_service, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet_service category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Internet Service Custom *arguments

Configure custom Internet Services in Fortinet's FortiOS and FortiGate.

Arguments: username, state, ssl_verify, firewall_internet_service_custom, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet_service_custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Internet Service Group *arguments

Configure group of Internet Service in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, firewall_internet_service_group, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and internet_service_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ip Translation *arguments

Configure firewall IP-translation in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, firewall_ip_translation, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ip_translation category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ipmacbinding Setting *arguments

Configure IP to MAC binding settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_ipmacbinding_setting, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ipmacbinding feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ipmacbinding Table *arguments

Configure IP to MAC address pairs in the IP/MAC binding table in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vdom, https, ssl_verify, password, firewall_ipmacbinding_table

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ipmacbinding feature and table category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ippool *arguments

Configure IPv4 IP pools in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_ippool, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ippool category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ippool6 *arguments

Configure IPv6 IP pools in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_ippool6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ippool6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ipv6 Eh Filter *arguments

Configure IPv6 extension header filter in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_ipv6_eh_filter, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ipv6_eh_filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ldb Monitor *arguments

Configure server load balancing health monitors in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_ldb_monitor, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ldb_monitor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Local In Policy *arguments

Configure user defined IPv4 local-in policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, firewall_local_in_policy, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and local_in_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Local In Policy6 *arguments

Configure user defined IPv6 local-in policies in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_local_in_policy6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and local_in_policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Multicast Address *arguments

Configure multicast addresses in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, firewall_multicast_address, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_address category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Multicast Address6 *arguments

Configure IPv6 multicast address in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_multicast_address6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_address6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Multicast Policy *arguments

Configure multicast NAT policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, firewall_multicast_policy, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Multicast Policy6 *arguments

Configure IPv6 multicast NAT policies in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_multicast_policy6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and multicast_policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Policy *arguments

Configure IPv4 policies in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_policy, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Policy46 *arguments

Configure IPv4 to IPv6 policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vdom, https, ssl_verify, password, firewall_policy46

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy46 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Policy6 *arguments

Configure IPv6 policies in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_policy6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Policy64 *arguments

Configure IPv6 to IPv4 policies in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, firewall_policy64, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and policy64 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Profile Group *arguments

Configure profile groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_profile_group, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and profile_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Profile Protocol Options *arguments

Configure protocol options in Fortinet's FortiOS and FortiGate.

Arguments: username, password, host, state, https, ssl_verify, firewall_profile_protocol_options, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and profile_protocol_options category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Proxy Address *arguments

Web proxy address configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, firewall_proxy_address, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and proxy_address category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Proxy Addrgrp *arguments

Web proxy address group configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_proxy_addrgrp, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and proxy_addrgrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Proxy Policy *arguments

Configure proxy policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, firewall_proxy_policy

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and proxy_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Schedule Group *arguments

Schedule group configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, firewall_schedule_group

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_schedule feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Schedule Onetime *arguments

Onetime schedule configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_schedule_onetime, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_schedule feature and onetime category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Schedule Recurring *arguments

Recurring schedule configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, firewall_schedule_recurring

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_schedule feature and recurring category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Service Category *arguments

Configure service categories in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_service_category, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_service feature and category category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Service Custom *arguments

Configure custom services in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_service_custom, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_service feature and custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Service Group *arguments

Configure service groups in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_service_group, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_service feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Shaper Per Ip Shaper *arguments

Configure per-IP traffic shaper in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_shaper_per_ip_shaper, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_shaper feature and per_ip_shaper category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Shaper Traffic Shaper *arguments

Configure shared traffic shaper in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, firewall_shaper_traffic_shaper, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_shaper feature and traffic_shaper category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Shaping Policy *arguments

Configure shaping policies in Fortinet's FortiOS and FortiGate.

Arguments: username, password, host, state, https, ssl_verify, firewall_shaping_policy, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and shaping_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Shaping Profile *arguments

Configure shaping profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_shaping_profile, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and shaping_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Sniffer *arguments

Configure sniffer in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, firewall_sniffer, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and sniffer category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ssh Host Key *arguments

SSH proxy host public keys in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_ssh_host_key, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ssh feature and host_key category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ssh Local Ca *arguments

SSH proxy local CA in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, firewall_ssh_local_ca, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ssh feature and local_ca category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ssh Local Key *arguments

SSH proxy local keys in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, firewall_ssh_local_key, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ssh feature and local_key category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ssh Setting *arguments

SSH proxy settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, firewall_ssh_setting

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ssh feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ssl Server *arguments

Configure SSL servers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_ssl_server, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ssl_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ssl Setting *arguments

SSL proxy settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, firewall_ssl_setting, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ssl feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ssl Ssh Profile *arguments

Configure SSL/SSH protocol options in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_ssl_ssh_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ssl_ssh_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Ttl Policy *arguments

Configure TTL policies in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, firewall_ttl_policy, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ttl_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vip *arguments

Configure virtual IP for IPv4 in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_vip, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vip46 *arguments

Configure IPv4 to IPv6 virtual IPs in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, firewall_vip46, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip46 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vip6 *arguments

Configure virtual IP for IPv6 in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_vip6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vip64 *arguments

Configure IPv6 to IPv4 virtual IPs in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_vip64, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vip64 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vipgrp *arguments

Configure IPv4 virtual IP groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, firewall_vipgrp, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vipgrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vipgrp46 *arguments

Configure IPv4 to IPv6 virtual IP groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_vipgrp46, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vipgrp46 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vipgrp6 *arguments

Configure IPv6 virtual IP groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, firewall_vipgrp6, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vipgrp6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Vipgrp64 *arguments

Configure IPv6 to IPv4 virtual IP groups in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_vipgrp64, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and vipgrp64 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Wildcard Fqdn Custom *arguments

Config global/VDOM Wildcard FQDN address in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_wildcard_fqdn_custom, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_wildcard_fqdn feature and custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Firewall Wildcard Fqdn Group *arguments

Config global Wildcard FQDN address groups in Fortinet's FortiOS and FortiGate.

Arguments: username, firewall_wildcard_fqdn_group, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_wildcard_fqdn feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ftp Proxy Explicit *arguments

Configure explicit FTP proxy settings in Fortinet's FortiOS and FortiGate.

Arguments: username, ftp_proxy_explicit, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ftp_proxy feature and explicit category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Icap Profile *arguments

Configure ICAP profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, icap_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify icap feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Icap Server *arguments

Configure ICAP servers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, icap_server, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify icap feature and server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ips Custom *arguments

Configure IPS custom signature in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ips_custom, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and custom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ips Decoder *arguments

Configure IPS decoder in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, ips_decoder, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and decoder category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ips Global *arguments

Configure IPS global parameter in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, ips_global, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ips Rule *arguments

Configure IPS rules in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, ips_rule

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and rule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ips Rule Settings *arguments

Configure IPS rule setting in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, ips_rule_settings, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and rule_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ips Sensor *arguments

Configure IPS sensor in Fortinet's FortiOS and FortiGate.

Arguments: username, ips_sensor, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and sensor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ips Settings *arguments

Configure IPS VDOM parameter in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, ips_settings

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ipv4 Policy *arguments

Manage IPv4 policy objects on Fortinet FortiOS firewall devices

Arguments: comment, schedule, application_list, src_intf, service_negate, av_profile, dst_addr_negate, logtraffic_start, id, fixedport, webfilter_profile, src_addr, service, poolname, policy_action, dst_intf, ips_sensor, state, nat, src_addr_negate, dst_addr, logtraffic

This module provides management of firewall IPv4 policies on FortiOS devices.

Fortios Log Custom Field *arguments

Configure custom log fields in Fortinet's FortiOS and FortiGate.

Arguments: username, log_custom_field, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and custom_field category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Disk Filter *arguments

Configure filters for local disk logging. Use these filters to determine the log messages to record according to severity and type in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, log_disk_filter, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_disk feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Disk Setting *arguments

Settings for local disk logging in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, log_disk_setting, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_disk feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Eventfilter *arguments

Configure log event filters in Fortinet's FortiOS and FortiGate.

Arguments: username, log_eventfilter, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and eventfilter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer Filter *arguments

Filters for FortiAnalyzer in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, log_fortianalyzer_filter, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer Override Filter *arguments

Override filters for FortiAnalyzer in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, log_fortianalyzer_override_filter, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer feature and override_filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer Override Setting *arguments

Override FortiAnalyzer settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, log_fortianalyzer_override_setting, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer feature and override_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer Setting *arguments

Global FortiAnalyzer settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, log_fortianalyzer_setting, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer2 Filter *arguments

Filters for FortiAnalyzer in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, vdom, log_fortianalyzer2_filter

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer2 feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer2 Setting *arguments

Global FortiAnalyzer settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, log_fortianalyzer2_setting

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer2 feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer3 Filter *arguments

Filters for FortiAnalyzer in Fortinet's FortiOS and FortiGate.

Arguments: username, log_fortianalyzer3_filter, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer3 feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortianalyzer3 Setting *arguments

Global FortiAnalyzer settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, vdom, log_fortianalyzer3_setting

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortianalyzer3 feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortiguard Filter *arguments

Filters for FortiCloud in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, log_fortiguard_filter, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortiguard feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortiguard Override Filter *arguments

Override filters for FortiCloud in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, log_fortiguard_override_filter, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortiguard feature and override_filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortiguard Override Setting *arguments

Override global FortiCloud logging settings for this VDOM in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, log_fortiguard_override_setting, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortiguard feature and override_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Fortiguard Setting *arguments

Configure logging to FortiCloud in Fortinet's FortiOS and FortiGate.

Arguments: username, log_fortiguard_setting, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_fortiguard feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Gui Display *arguments

Configure how log messages are displayed on the GUI in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, log_gui_display, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and gui_display category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Memory Filter *arguments

Filters for memory buffer in Fortinet's FortiOS and FortiGate.

Arguments: username, host, log_memory_filter, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_memory feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Memory Global Setting *arguments

Global settings for memory logging in Fortinet's FortiOS and FortiGate.

Arguments: username, log_memory_global_setting, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_memory feature and global_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Memory Setting *arguments

Settings for memory buffer in Fortinet's FortiOS and FortiGate.

Arguments: username, host, log_memory_setting, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_memory feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Null Device Filter *arguments

Filters for null device logging in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, log_null_device_filter

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_null_device feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Null Device Setting *arguments

Settings for null device logging in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, log_null_device_setting, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_null_device feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Setting *arguments

Configure general log settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, log_setting, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd Filter *arguments

Filters for remote system server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, log_syslogd_filter, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd Override Filter *arguments

Override filters for remote system server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, log_syslogd_override_filter, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd feature and override_filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd Override Setting *arguments

Override settings for remote syslog server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, log_syslogd_override_setting, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd feature and override_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd Setting *arguments

Global settings for remote syslog server in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, log_syslogd_setting, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd2 Filter *arguments

Filters for remote system server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, log_syslogd2_filter, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd2 feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd2 Setting *arguments

Global settings for remote syslog server in Fortinet's FortiOS and FortiGate.

Arguments: username, log_syslogd2_setting, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd2 feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd3 Filter *arguments

Filters for remote system server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, log_syslogd3_filter, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd3 feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd3 Setting *arguments

Global settings for remote syslog server in Fortinet's FortiOS and FortiGate.

Arguments: username, log_syslogd3_setting, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd3 feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd4 Filter *arguments

Filters for remote system server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, log_syslogd4_filter, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd4 feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Syslogd4 Setting *arguments

Global settings for remote syslog server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, vdom, log_syslogd4_setting

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_syslogd4 feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Threat Weight *arguments

Configure threat weight settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, log_threat_weight, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log feature and threat_weight category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Webtrends Filter *arguments

Filters for WebTrends in Fortinet's FortiOS and FortiGate.

Arguments: username, log_webtrends_filter, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_webtrends feature and filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Log Webtrends Setting *arguments

Settings for WebTrends in Fortinet's FortiOS and FortiGate.

Arguments: username, log_webtrends_setting, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify log_webtrends feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Report Chart *arguments

Report chart widget configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, report_chart, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and chart category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Report Dataset *arguments

Report dataset configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, report_dataset, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and dataset category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Report Layout *arguments

Report layout configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, report_layout, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and layout category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Report Setting *arguments

Report setting configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, report_setting, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Report Style *arguments

Report style configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, report_style, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and style category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Report Theme *arguments

Report themes configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, report_theme, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify report feature and theme category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Access List *arguments

Configure access lists in Fortinet's FortiOS and FortiGate.

Arguments: username, router_access_list, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and access_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Access List6 *arguments

Configure IPv6 access lists in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, router_access_list6, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and access_list6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Aspath List *arguments

Configure Autonomous System (AS) path lists in Fortinet's FortiOS and FortiGate.

Arguments: username, host, router_aspath_list, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and aspath_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Auth Path *arguments

Configure authentication based routing in Fortinet's FortiOS and FortiGate.

Arguments: username, router_auth_path, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and auth_path category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Bfd *arguments

Configure BFD in Fortinet's FortiOS and FortiGate.

Arguments: username, router_bfd, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and bfd category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Bfd6 *arguments

Configure IPv6 BFD in Fortinet's FortiOS and FortiGate.

Arguments: username, host, router_bfd6, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and bfd6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Bgp *arguments

Configure BGP in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, router_bgp, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and bgp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Community List *arguments

Configure community lists in Fortinet's FortiOS and FortiGate.

Arguments: username, router_community_list, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and community_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Isis *arguments

Configure IS-IS in Fortinet's FortiOS and FortiGate.

Arguments: username, router_isis, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and isis category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Key Chain *arguments

Configure key-chain in Fortinet's FortiOS and FortiGate.

Arguments: username, router_key_chain, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and key_chain category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Multicast *arguments

Configure router multicast in Fortinet's FortiOS and FortiGate.

Arguments: username, router_multicast, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and multicast category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Multicast Flow *arguments

Configure multicast-flow in Fortinet's FortiOS and FortiGate.

Arguments: username, router_multicast_flow, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and multicast_flow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Multicast6 *arguments

Configure IPv6 multicast in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, router_multicast6, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and multicast6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Ospf *arguments

Configure OSPF in Fortinet's FortiOS and FortiGate.

Arguments: username, host, router_ospf, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and ospf category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Ospf6 *arguments

Configure IPv6 OSPF in Fortinet's FortiOS and FortiGate.

Arguments: username, router_ospf6, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and ospf6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Policy *arguments

Configure IPv4 routing policies in Fortinet's FortiOS and FortiGate.

Arguments: username, router_policy, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Policy6 *arguments

Configure IPv6 routing policies in Fortinet's FortiOS and FortiGate.

Arguments: username, router_policy6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and policy6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Prefix List *arguments

Configure IPv4 prefix lists in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, router_prefix_list

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and prefix_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Prefix List6 *arguments

Configure IPv6 prefix lists in Fortinet's FortiOS and FortiGate.

Arguments: username, router_prefix_list6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and prefix_list6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Rip *arguments

Configure RIP in Fortinet's FortiOS and FortiGate.

Arguments: username, host, router_rip, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and rip category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Ripng *arguments

Configure RIPng in Fortinet's FortiOS and FortiGate.

Arguments: username, router_ripng, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and ripng category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Route Map *arguments

Configure route maps in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, router_route_map, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and route_map category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Setting *arguments

Configure router settings in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, router_setting, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Static *arguments

Configure IPv4 static routing tables in Fortinet's FortiOS and FortiGate.

Arguments: username, host, router_static, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and static category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Router Static6 *arguments

Configure IPv6 static routing tables in Fortinet's FortiOS and FortiGate.

Arguments: username, router_static6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify router feature and static6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Bwl *arguments

Configure anti-spam black/white list in Fortinet's FortiOS and FortiGate.

Arguments: username, spamfilter_bwl, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and bwl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Bword *arguments

Configure AntiSpam banned word list in Fortinet's FortiOS and FortiGate.

Arguments: username, spamfilter_bword, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and bword category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Dnsbl *arguments

Configure AntiSpam DNSBL/ORBL in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, spamfilter_dnsbl

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and dnsbl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Fortishield *arguments

Configure FortiGuard - AntiSpam in Fortinet's FortiOS and FortiGate.

Arguments: username, spamfilter_fortishield, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and fortishield category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Iptrust *arguments

Configure AntiSpam IP trust in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, spamfilter_iptrust, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and iptrust category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Mheader *arguments

Configure AntiSpam MIME header in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, spamfilter_mheader, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and mheader category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Options *arguments

Configure AntiSpam options in Fortinet's FortiOS and FortiGate.

Arguments: username, host, spamfilter_options, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and options category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Spamfilter Profile *arguments

Configure AntiSpam profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, spamfilter_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Ssh Filter Profile *arguments

SSH filter profile in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, ssh_filter_profile

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ssh_filter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller 802 1X Settings *arguments

Configure global 802.1X settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, switch_controller_802_1X_settings, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and 802_1X_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Custom Command *arguments

Configure the FortiGate switch controller to send custom commands to managed FortiSwitch devices in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, switch_controller_custom_command, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and custom_command category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Global *arguments

Configure FortiSwitch global settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, switch_controller_global, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Igmp Snooping *arguments

Configure FortiSwitch IGMP snooping global settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, switch_controller_igmp_snooping, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and igmp_snooping category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Lldp Profile *arguments

Configure FortiSwitch LLDP profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, switch_controller_lldp_profile, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and lldp_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Lldp Settings *arguments

Configure FortiSwitch LLDP settings in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_lldp_settings, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and lldp_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Mac Sync Settings *arguments

Configure global MAC synchronization settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, switch_controller_mac_sync_settings

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and mac_sync_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Managed Switch *arguments

Configure FortiSwitch devices that are managed by this FortiGate in Fortinet's FortiOS and FortiGate.

Arguments: username, host, switch_controller_managed_switch, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and managed_switch category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Network Monitor Settings *arguments

Configure network monitor settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, switch_controller_network_monitor_settings, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and network_monitor_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Qos Dot1p Map *arguments

Configure FortiSwitch QoS 802.1p in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vdom, https, ssl_verify, password, switch_controller_qos_dot1p_map

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_qos feature and dot1p_map category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Qos Ip Dscp Map *arguments

Configure FortiSwitch QoS IP precedence/DSCP in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_qos_ip_dscp_map, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_qos feature and ip_dscp_map category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Qos Qos Policy *arguments

Configure FortiSwitch QoS policy in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_qos_qos_policy, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_qos feature and qos_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Qos Queue Policy *arguments

Configure FortiSwitch QoS egress queue policy in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_qos_queue_policy, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_qos feature and queue_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Quarantine *arguments

Configure FortiSwitch quarantine support in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_quarantine, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and quarantine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Security Policy 802 1X *arguments

Configure 802.1x MAC Authentication Bypass (MAB) policies in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, switch_controller_security_policy_802_1X, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_security_policy feature and 802_1X category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Security Policy Captive Portal *arguments

Names of VLANs that use captive portal authentication in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, switch_controller_security_policy_captive_portal

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller_security_policy feature and captive_portal category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Sflow *arguments

Configure FortiSwitch sFlow in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, switch_controller_sflow

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and sflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Storm Control *arguments

Configure FortiSwitch storm control in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, switch_controller_storm_control, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and storm_control category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Stp Settings *arguments

Configure FortiSwitch spanning tree protocol (STP) in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, switch_controller_stp_settings, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and stp_settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Switch Group *arguments

Configure FortiSwitch switch groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, switch_controller_switch_group, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and switch_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Switch Interface Tag *arguments

Configure switch object tags in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_switch_interface_tag, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and switch_interface_tag category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Switch Log *arguments

Configure FortiSwitch logging (logs are transferred to and inserted into FortiGate event log) in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, switch_controller_switch_log, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and switch_log category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Switch Profile *arguments

Configure FortiSwitch switch profile in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_switch_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and switch_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller System *arguments

Configure system-wide switch controller settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, switch_controller_system, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and system category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Virtual Port Pool *arguments

Configure virtual pool in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_virtual_port_pool, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and virtual_port_pool category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Switch Controller Vlan *arguments

Configure VLANs for switch controller in Fortinet's FortiOS and FortiGate.

Arguments: username, switch_controller_vlan, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and vlan category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Accprofile *arguments

Configure access profiles for system administrators in Fortinet's FortiOS and FortiGate.

Arguments: username, system_accprofile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and accprofile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Admin *arguments

Configure admin users in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, system_admin

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and admin category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Affinity Interrupt *arguments

Configure interrupt affinity in Fortinet's FortiOS and FortiGate.

Arguments: username, system_affinity_interrupt, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and affinity_interrupt category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Affinity Packet Redistribution *arguments

Configure packet redistribution in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, system_affinity_packet_redistribution, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and affinity_packet_redistribution category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Alarm *arguments

Configure alarm in Fortinet's FortiOS and FortiGate.

Arguments: username, system_alarm, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and alarm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Alias *arguments

Configure alias command in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_alias, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and alias category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Api User *arguments

Configure API users in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, system_api_user

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and api_user category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Arp Table *arguments

Configure ARP table in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_arp_table, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and arp_table category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Auto Install *arguments

Configure USB auto installation in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_auto_install, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and auto_install category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Auto Script *arguments

Configure auto script in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_auto_script, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and auto_script category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Automation Action *arguments

Action for automation stitches in Fortinet's FortiOS and FortiGate.

Arguments: username, system_automation_action, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and automation_action category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Automation Destination *arguments

Automation destinations in Fortinet's FortiOS and FortiGate.

Arguments: username, system_automation_destination, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and automation_destination category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Automation Stitch *arguments

Automation stitches in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_automation_stitch, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and automation_stitch category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Automation Trigger *arguments

Trigger for automation stitches in Fortinet's FortiOS and FortiGate.

Arguments: username, password, host, state, https, ssl_verify, system_automation_trigger, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and automation_trigger category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Autoupdate Push Update *arguments

Configure push updates in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, system_autoupdate_push_update, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_autoupdate feature and push_update category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Autoupdate Schedule *arguments

Configure update schedule in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, system_autoupdate_schedule, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_autoupdate feature and schedule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Autoupdate Tunneling *arguments

Configure web proxy tunnelling for the FDN in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, system_autoupdate_tunneling, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_autoupdate feature and tunneling category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Central Management *arguments

Configure central management in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, system_central_management, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and central_management category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Cluster Sync *arguments

Configure FortiGate Session Life Support Protocol (FGSP) session synchronization in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_cluster_sync, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and cluster_sync category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Console *arguments

Configure console in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, vdom, system_console

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and console category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Csf *arguments

Add this FortiGate to a Security Fabric or set up a new Security Fabric on this FortiGate in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_csf, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and csf category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Custom Language *arguments

Configure custom languages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_custom_language, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and custom_language category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ddns *arguments

Configure DDNS in Fortinet's FortiOS and FortiGate.

Arguments: username, system_ddns, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ddns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Dedicated Mgmt *arguments

Configure dedicated management in Fortinet's FortiOS and FortiGate.

Arguments: username, system_dedicated_mgmt, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and dedicated_mgmt category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Dhcp Server *arguments

Configure DHCP servers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_dhcp_server, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_dhcp feature and server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Dhcp6 Server *arguments

Configure DHCPv6 servers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_dhcp6_server, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_dhcp6 feature and server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Dns *arguments

Configure DNS in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_dns, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Dns Database *arguments

Configure DNS databases in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_dns_database, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and dns_database category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Dns Server *arguments

Configure DNS servers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_dns_server, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and dns_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Dscp Based Priority *arguments

Configure DSCP based priority table in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_dscp_based_priority, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and dscp_based_priority category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Email Server *arguments

Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, system_email_server, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and email_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System External Resource *arguments

Configure external resource in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_external_resource, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and external_resource category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Fips Cc *arguments

Configure FIPS-CC mode in Fortinet's FortiOS and FortiGate.

Arguments: username, system_fips_cc, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fips_cc category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Firmware Upgrade *arguments

Perform firmware upgrade on FortiGate or FortiOS (FOS) device.

Arguments: username, host, https, system_firmware, ssl_verify, password, vdom

This module is able to perform firmware upgrade on FortiGate or FortiOS (FOS) device by specifying firmware upgrade source, filename and whether format boot partition before upgrade. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Fortios System Fm *arguments

Configure FM in Fortinet's FortiOS and FortiGate.

Arguments: username, system_fm, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Fortiguard *arguments

Configure FortiGuard services in Fortinet's FortiOS and FortiGate.

Arguments: username, system_fortiguard, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fortiguard category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Fortimanager *arguments

Configure FortiManager in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, system_fortimanager, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fortimanager category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Fortisandbox *arguments

Configure FortiSandbox in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_fortisandbox, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fortisandbox category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Fsso Polling *arguments

Configure Fortinet Single Sign On (FSSO) server in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, system_fsso_polling, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and fsso_polling category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ftm Push *arguments

Configure FortiToken Mobile push services in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, system_ftm_push, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ftm_push category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Geoip Override *arguments

Configure geographical location mapping for IP address(es) to override mappings from FortiGuard in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, system_geoip_override, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and geoip_override category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Global *arguments

Configure global attributes in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, system_global, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Gre Tunnel *arguments

Configure GRE tunnel in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, system_gre_tunnel, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and gre_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ha *arguments

Configure HA in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, system_ha

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ha category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ha Monitor *arguments

Configure HA monitor in Fortinet's FortiOS and FortiGate.

Arguments: username, system_ha_monitor, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ha_monitor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Interface *arguments

Configure interfaces in Fortinet's FortiOS and FortiGate.

Arguments: username, system_interface, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ipip Tunnel *arguments

Configure IP in IP Tunneling in Fortinet's FortiOS and FortiGate.

Arguments: username, system_ipip_tunnel, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ipip_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ips Urlfilter Dns *arguments

Configure IPS URL filter DNS servers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_ips_urlfilter_dns, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ips_urlfilter_dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ips Urlfilter Dns6 *arguments

Configure IPS URL filter IPv6 DNS servers in Fortinet's FortiOS and FortiGate.

Arguments: username, system_ips_urlfilter_dns6, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ips_urlfilter_dns6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ipv6 Neighbor Cache *arguments

Configure IPv6 neighbor cache table in Fortinet's FortiOS and FortiGate.

Arguments: username, system_ipv6_neighbor_cache, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ipv6_neighbor_cache category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ipv6 Tunnel *arguments

Configure IPv6/IPv4 in IPv6 tunnel in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, system_ipv6_tunnel, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ipv6_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Link Monitor *arguments

Configure Link Health Monitor in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_link_monitor, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and link_monitor category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Mac Address Table *arguments

Configure MAC address tables in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, system_mac_address_table

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and mac_address_table category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Management Tunnel *arguments

Management tunnel configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_management_tunnel, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and management_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Mobile Tunnel *arguments

Configure Mobile tunnels, an implementation of Network Mobility (NEMO) extensions for Mobile IPv4 RFC5177 in Fortinet's FortiOS and FortiGate.

Arguments: username, system_mobile_tunnel, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and mobile_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Nat64 *arguments

Configure NAT64 in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_nat64, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and nat64 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Nd Proxy *arguments

Configure IPv6 neighbor discovery proxy (RFC4389) in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, system_nd_proxy, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and nd_proxy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Netflow *arguments

Configure NetFlow in Fortinet's FortiOS and FortiGate.

Arguments: username, system_netflow, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and netflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Network Visibility *arguments

Configure network visibility settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vdom, https, ssl_verify, password, system_network_visibility

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and network_visibility category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Ntp *arguments

Configure system NTP information in Fortinet's FortiOS and FortiGate.

Arguments: username, system_ntp, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and ntp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Object Tagging *arguments

Configure object tagging in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, system_object_tagging, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and object_tagging category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Password Policy *arguments

Configure password policy for locally defined administrator passwords and IPsec VPN pre-shared keys in Fortinet's FortiOS and FortiGate.

Arguments: username, system_password_policy, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and password_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Password Policy Guest Admin *arguments

Configure the password policy for guest administrators in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, system_password_policy_guest_admin, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and password_policy_guest_admin category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Pppoe Interface *arguments

Configure the PPPoE interfaces in Fortinet's FortiOS and FortiGate.

Arguments: username, system_pppoe_interface, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and pppoe_interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Probe Response *arguments

Configure system probe response in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, system_probe_response, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and probe_response category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Proxy Arp *arguments

Configure proxy-ARP in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, system_proxy_arp, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and proxy_arp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Admin *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_replacemsg_admin, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and admin category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Alertmail *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_alertmail, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and alertmail category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Auth *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_auth, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and auth category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Device Detection Portal *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_device_detection_portal, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and device_detection_portal category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Ec *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_ec, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and ec category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Fortiguard Wf *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_replacemsg_fortiguard_wf, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and fortiguard_wf category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Ftp *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_ftp, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and ftp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Group *arguments

Configure replacement message groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_replacemsg_group, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and replacemsg_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Http *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_replacemsg_http, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and http category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Icap *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_replacemsg_icap, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and icap category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Image *arguments

Configure replacement message images in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_image, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and replacemsg_image category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Mail *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, system_replacemsg_mail

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and mail category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Nac Quar *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_replacemsg_nac_quar, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and nac_quar category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Nntp *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_replacemsg_nntp, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and nntp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Spam *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_replacemsg_spam, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and spam category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Sslvpn *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_sslvpn, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and sslvpn category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Traffic Quota *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, system_replacemsg_traffic_quota, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and traffic_quota category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Utm *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_replacemsg_utm, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and utm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Replacemsg Webproxy *arguments

Replacement messages in Fortinet's FortiOS and FortiGate.

Arguments: username, system_replacemsg_webproxy, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_replacemsg feature and webproxy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Resource Limits *arguments

Configure resource limits in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, system_resource_limits, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and resource_limits category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Sdn Connector *arguments

Configure connection to SDN Connector in Fortinet's FortiOS and FortiGate.

Arguments: username, password, host, state, https, ssl_verify, system_sdn_connector, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sdn_connector category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Session Helper *arguments

Configure session helper in Fortinet's FortiOS and FortiGate.

Arguments: username, system_session_helper, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and session_helper category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Session Ttl *arguments

Configure global session TTL timers for this FortiGate in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, system_session_ttl, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and session_ttl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Settings *arguments

Configure VDOM settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, system_settings, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Sflow *arguments

Configure sFlow in Fortinet's FortiOS and FortiGate.

Arguments: username, system_sflow, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Sit Tunnel *arguments

Configure IPv6 tunnel over IPv4 in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vdom, https, ssl_verify, password, system_sit_tunnel

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sit_tunnel category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Sms Server *arguments

Configure SMS server for sending SMS messages to support user authentication in Fortinet's FortiOS and FortiGate.

Arguments: username, system_sms_server, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and sms_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Snmp Community *arguments

SNMP community configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, system_snmp_community, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_snmp feature and community category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Snmp Sysinfo *arguments

SNMP system info configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, system_snmp_sysinfo, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_snmp feature and sysinfo category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Snmp User *arguments

SNMP user configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_snmp_user, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system_snmp feature and user category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Storage *arguments

Configure logical storage in Fortinet's FortiOS and FortiGate.

Arguments: username, password, host, state, https, ssl_verify, system_storage, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and storage category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Switch Interface *arguments

Configure software switch interfaces by grouping physical and WiFi interfaces in Fortinet's FortiOS and FortiGate.

Arguments: username, system_switch_interface, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and switch_interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Tos Based Priority *arguments

Configure Type of Service (ToS) based priority table to set network traffic priorities in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_tos_based_priority, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and tos_based_priority category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom *arguments

Configure virtual domain in Fortinet's FortiOS and FortiGate.

Arguments: username, system_vdom, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom Dns *arguments

Configure DNS servers for a non-management VDOM in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_vdom_dns, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_dns category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom Exception *arguments

Global configuration objects that can be configured independently for all VDOMs or for the defined VDOM scope in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, system_vdom_exception

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_exception category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom Link *arguments

Configure VDOM links in Fortinet's FortiOS and FortiGate.

Arguments: username, password, host, state, https, ssl_verify, system_vdom_link, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_link category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom Netflow *arguments

Configure NetFlow per VDOM in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, system_vdom_netflow, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_netflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom Property *arguments

Configure VDOM property in Fortinet's FortiOS and FortiGate.

Arguments: username, system_vdom_property, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_property category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom Radius Server *arguments

Configure a RADIUS server to use as a RADIUS Single Sign On (RSSO) server for this VDOM in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, system_vdom_radius_server, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_radius_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vdom Sflow *arguments

Configure sFlow per VDOM to add or change the IP address and UDP port that FortiGate sFlow agents in this VDOM use to send sFlow datagrams to an sFlow collector in Fortinet's FortiOS and FortiGate.

Arguments: username, host, system_vdom_sflow, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vdom_sflow category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Virtual Wan Link *arguments

Configure redundant internet connections using SD-WAN (formerly virtual WAN link) in Fortinet's FortiOS and FortiGate.

Arguments: username, system_virtual_wan_link, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and virtual_wan_link category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Virtual Wire Pair *arguments

Configure virtual wire pairs in Fortinet's FortiOS and FortiGate.

Arguments: username, system_virtual_wire_pair, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and virtual_wire_pair category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Vxlan *arguments

Configure VXLAN devices in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, system_vxlan, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and vxlan category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Wccp *arguments

Configure WCCP in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, system_wccp, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and wccp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios System Zone *arguments

Configure zones to group two or more interfaces. When a zone is created you can configure policies for the zone instead of individual interfaces in the zone in Fortinet's FortiOS and FortiGate.

Arguments: username, system_zone, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify system feature and zone category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Adgrp *arguments

Configure FSSO groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, user_adgrp, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and adgrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Device *arguments

Configure devices in Fortinet's FortiOS and FortiGate.

Arguments: username, user_device, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Device Access List *arguments

Configure device access control lists in Fortinet's FortiOS and FortiGate.

Arguments: username, user_device_access_list, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device_access_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Device Category *arguments

Configure device categories in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, user_device_category, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device_category category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Device Group *arguments

Configure device groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, user_device_group

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and device_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Domain Controller *arguments

Configure domain controller entries in Fortinet's FortiOS and FortiGate.

Arguments: username, user_domain_controller, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and domain_controller category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Fortitoken *arguments

Configure FortiToken in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, user_fortitoken, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and fortitoken category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Fsso *arguments

Configure Fortinet Single Sign On (FSSO) agents in Fortinet's FortiOS and FortiGate.

Arguments: username, user_fsso, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and fsso category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Fsso Polling *arguments

Configure FSSO active directory servers for polling mode in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, user_fsso_polling, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and fsso_polling category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Group *arguments

Configure user groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, user_group, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Krb Keytab *arguments

Configure Kerberos keytab entries in Fortinet's FortiOS and FortiGate.

Arguments: username, user_krb_keytab, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and krb_keytab category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Ldap *arguments

Configure LDAP server entries in Fortinet's FortiOS and FortiGate.

Arguments: username, user_ldap, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and ldap category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Local *arguments

Configure local users in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, user_local

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and local category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Password Policy *arguments

Configure user password policy in Fortinet's FortiOS and FortiGate.

Arguments: username, user_password_policy, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and password_policy category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Peer *arguments

Configure peer users in Fortinet's FortiOS and FortiGate.

Arguments: username, host, user_peer, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and peer category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Peergrp *arguments

Configure peer groups in Fortinet's FortiOS and FortiGate.

Arguments: username, user_peergrp, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and peergrp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Pop3 *arguments

POP3 server entry configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, user_pop3, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and pop3 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Quarantine *arguments

Configure quarantine support in Fortinet's FortiOS and FortiGate.

Arguments: username, host, password, https, ssl_verify, user_quarantine, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and quarantine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Radius *arguments

Configure RADIUS server entries in Fortinet's FortiOS and FortiGate.

Arguments: username, user_radius, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and radius category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Security Exempt List *arguments

Configure security exemption list in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vdom, https, ssl_verify, password, user_security_exempt_list

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and security_exempt_list category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Setting *arguments

Configure user authentication setting in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, user_setting, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios User Tacacsplus *arguments

Configure TACACS+ server entries in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, user_tacacsplus, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and tacacsplus category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Voip Profile *arguments

Configure VoIP profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, voip_profile, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify voip feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Certificate Ca *arguments

CA certificate in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, vpn_certificate_ca, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_certificate feature and ca category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Certificate Crl *arguments

Certificate Revocation List as a PEM file in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, vpn_certificate_crl, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_certificate feature and crl category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Certificate Local *arguments

Local keys and certificates in Fortinet's FortiOS and FortiGate.

Arguments: username, vpn_certificate_local, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_certificate feature and local category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Certificate Ocsp Server *arguments

OCSP server configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, vpn_certificate_ocsp_server, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_certificate feature and ocsp_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Certificate Remote *arguments

Remote certificate as a PEM file in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vpn_certificate_remote, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_certificate feature and remote category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Certificate Setting *arguments

VPN certificate setting in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, vpn_certificate_setting, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_certificate feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Concentrator *arguments

Concentrator configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vpn_ipsec_concentrator, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and concentrator category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Forticlient *arguments

Configure FortiClient policy realm in Fortinet's FortiOS and FortiGate.

Arguments: username, vpn_ipsec_forticlient, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and forticlient category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Manualkey *arguments

Configure IPsec manual keys in Fortinet's FortiOS and FortiGate.

Arguments: username, vpn_ipsec_manualkey, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and manualkey category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Manualkey Interface *arguments

Configure IPsec manual keys in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, vpn_ipsec_manualkey_interface, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and manualkey_interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Phase1 *arguments

Configure VPN remote gateway in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vpn_ipsec_phase1, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and phase1 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Phase1 Interface *arguments

Configure VPN remote gateway in Fortinet's FortiOS and FortiGate.

Arguments: username, state, ssl_verify, vpn_ipsec_phase1_interface, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and phase1_interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Phase2 *arguments

Configure VPN autokey tunnel in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vpn_ipsec_phase2, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and phase2 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ipsec Phase2 Interface *arguments

Configure VPN autokey tunnel in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, vpn_ipsec_phase2_interface, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ipsec feature and phase2_interface category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn L2tp *arguments

Configure L2TP in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vpn_l2tp, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn feature and l2tp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Pptp *arguments

Configure PPTP in Fortinet's FortiOS and FortiGate.

Arguments: username, host, vpn_pptp, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn feature and pptp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ssl Settings *arguments

Configure SSL VPN in Fortinet's FortiOS and FortiGate.

Arguments: username, vpn_ssl_settings, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ssl Web Host Check Software *arguments

SSL-VPN host check software in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, vpn_ssl_web_host_check_software, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl_web feature and host_check_software category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ssl Web Portal *arguments

Portal in Fortinet's FortiOS and FortiGate.

Arguments: username, vpn_ssl_web_portal, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl_web feature and portal category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ssl Web Realm *arguments

Realm in Fortinet's FortiOS and FortiGate.

Arguments: username, vpn_ssl_web_realm, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl_web feature and realm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ssl Web User Bookmark *arguments

Configure SSL VPN user bookmark in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, vpn_ssl_web_user_bookmark, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl_web feature and user_bookmark category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Vpn Ssl Web User Group Bookmark *arguments

Configure SSL VPN user group bookmark in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vpn_ssl_web_user_group_bookmark, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl_web feature and user_group_bookmark category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Waf Main Class *arguments

Hidden table for datasource in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, waf_main_class, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify waf feature and main_class category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Waf Profile *arguments

Web application firewall configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, waf_profile, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify waf feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Waf Signature *arguments

Hidden table for datasource in Fortinet's FortiOS and FortiGate.

Arguments: username, waf_signature, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify waf feature and signature category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Waf Sub Class *arguments

Hidden table for datasource in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, waf_sub_class, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify waf feature and sub_class category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Auth Group *arguments

Configure WAN optimization authentication groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, wanopt_auth_group

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and auth_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Cache Service *arguments

Designate cache-service for wan-optimization and webcache in Fortinet's FortiOS and FortiGate.

Arguments: username, wanopt_cache_service, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and cache_service category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Content Delivery Network Rule *arguments

Configure WAN optimization content delivery network rules in Fortinet's FortiOS and FortiGate.

Arguments: username, wanopt_content_delivery_network_rule, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and content_delivery_network_rule category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Peer *arguments

Configure WAN optimization peers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, wanopt_peer, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and peer category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Profile *arguments

Configure WAN optimization profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, wanopt_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Remote Storage *arguments

Configure a remote cache device as Web cache storage in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, wanopt_remote_storage, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and remote_storage category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Settings *arguments

Configure WAN optimization settings in Fortinet's FortiOS and FortiGate.

Arguments: username, wanopt_settings, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wanopt Webcache *arguments

Configure global Web cache settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, wanopt_webcache, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wanopt feature and webcache category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Debug Url *arguments

Configure debug URL addresses in Fortinet's FortiOS and FortiGate.

Arguments: username, web_proxy_debug_url, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and debug_url category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Explicit *arguments

Configure explicit Web proxy settings in Fortinet's FortiOS and FortiGate.

Arguments: username, web_proxy_explicit, host, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and explicit category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Forward Server *arguments

Configure forward-server addresses in Fortinet's FortiOS and FortiGate.

Arguments: username, web_proxy_forward_server, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and forward_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Forward Server Group *arguments

Configure a forward server group consisting or multiple forward servers. Supports failover and load balancing in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, web_proxy_forward_server_group, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and forward_server_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Global *arguments

Configure Web proxy global settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, web_proxy_global, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Profile *arguments

Configure web proxy profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, web_proxy_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Url Match *arguments

Exempt URLs from web proxy forwarding and caching in Fortinet's FortiOS and FortiGate.

Arguments: username, web_proxy_url_match, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and url_match category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Web Proxy Wisp *arguments

Configure Wireless Internet service provider (WISP) servers in Fortinet's FortiOS and FortiGate.

Arguments: username, host, web_proxy_wisp, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify web_proxy feature and wisp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter *arguments

Configure webfilter capabilities of FortiGate and FortiOS.

Arguments: username, host, password, webfilter_url, vdom, webfilter_content

This module is able to configure a FortiGate or FortiOS by allowing the user to configure webfilter feature. For now it is able to handle url and content filtering capabilities. The module uses FortiGate REST API internally to configure the device.

Fortios Webfilter Content *arguments

Configure Web filter banned word table in Fortinet's FortiOS and FortiGate.

Arguments: username, host, webfilter_content, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and content category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Content Header *arguments

Configure content types used by Web filter in Fortinet's FortiOS and FortiGate.

Arguments: username, webfilter_content_header, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and content_header category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Fortiguard *arguments

Configure FortiGuard Web Filter service in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, webfilter_fortiguard, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and fortiguard category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Ftgd Local Cat *arguments

Configure FortiGuard Web Filter local categories in Fortinet's FortiOS and FortiGate.

Arguments: username, webfilter_ftgd_local_cat, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and ftgd_local_cat category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Ftgd Local Rating *arguments

Configure local FortiGuard Web Filter local ratings in Fortinet's FortiOS and FortiGate.

Arguments: username, webfilter_ftgd_local_rating, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and ftgd_local_rating category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Ips Urlfilter Cache Setting *arguments

Configure IPS URL filter cache settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, webfilter_ips_urlfilter_cache_setting, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and ips_urlfilter_cache_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Ips Urlfilter Setting *arguments

Configure IPS URL filter settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, webfilter_ips_urlfilter_setting, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and ips_urlfilter_setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Ips Urlfilter Setting6 *arguments

Configure IPS URL filter settings for IPv6 in Fortinet's FortiOS and FortiGate.

Arguments: username, ssl_verify, host, https, webfilter_ips_urlfilter_setting6, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and ips_urlfilter_setting6 category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Override *arguments

Configure FortiGuard Web Filter administrative overrides in Fortinet's FortiOS and FortiGate.

Arguments: username, webfilter_override, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and override category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Profile *arguments

Configure Web filter profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, webfilter_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Search Engine *arguments

Configure web filter search engines in Fortinet's FortiOS and FortiGate.

Arguments: username, webfilter_search_engine, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and search_engine category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Webfilter Urlfilter *arguments

Configure URL filter lists in Fortinet's FortiOS and FortiGate.

Arguments: username, webfilter_urlfilter, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify webfilter feature and urlfilter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Ap Status *arguments

Configure access point status (rogue | accepted | suppressed) in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_ap_status, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and ap_status category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Ble Profile *arguments

Configure Bluetooth Low Energy profile in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, wireless_controller_ble_profile, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and ble_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Bonjour Profile *arguments

Configure Bonjour profiles. Bonjour is Apple's zero configuration networking protocol. Bonjour profiles allow APs and FortiAPs to connect to networks using Bonjour in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_bonjour_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and bonjour_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Global *arguments

Configure wireless controller global settings in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, password, wireless_controller_global, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 Anqp 3gpp Cellular *arguments

Configure 3GPP public land mobile network (PLMN) in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_hotspot20_anqp_3gpp_cellular, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and anqp_3gpp_cellular category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 Anqp Ip Address Type *arguments

Configure IP address type availability in Fortinet's FortiOS and FortiGate.

Arguments: username, host, ssl_verify, state, https, wireless_controller_hotspot20_anqp_ip_address_type, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and anqp_ip_address_type category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 Anqp Nai Realm *arguments

Configure network access identifier (NAI) realm in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, wireless_controller_hotspot20_anqp_nai_realm, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and anqp_nai_realm category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.4

Fortios Wireless Controller Hotspot20 Anqp Network Auth Type *arguments

Configure network authentication type in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_hotspot20_anqp_network_auth_type, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and anqp_network_auth_type category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 Anqp Roaming Consortium *arguments

Configure roaming consortium in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, vdom, wireless_controller_hotspot20_anqp_roaming_consortium

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and anqp_roaming_consortium category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 Anqp Venue Name *arguments

Configure venue name duple in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, wireless_controller_hotspot20_anqp_venue_name, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and anqp_venue_name category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 H2qp Conn Capability *arguments

Configure connection capability in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, wireless_controller_hotspot20_h2qp_conn_capability, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and h2qp_conn_capability category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 H2qp Operator Name *arguments

Configure operator friendly name in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_hotspot20_h2qp_operator_name, ssl_verify, state, https, host, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and h2qp_operator_name category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 H2qp Osu Provider *arguments

Configure online sign up (OSU) provider list in Fortinet's FortiOS and FortiGate.

Arguments: username, https, host, state, wireless_controller_hotspot20_h2qp_osu_provider, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and h2qp_osu_provider category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 H2qp Wan Metric *arguments

Configure WAN metrics in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_hotspot20_h2qp_wan_metric, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and h2qp_wan_metric category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 Hs Profile *arguments

Configure hotspot profile in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_hotspot20_hs_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and hs_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.4

Fortios Wireless Controller Hotspot20 Icon *arguments

Configure OSU provider icon in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, wireless_controller_hotspot20_icon, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and icon category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Hotspot20 Qos Map *arguments

Configure QoS map set in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, wireless_controller_hotspot20_qos_map, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller_hotspot20 feature and qos_map category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Inter Controller *arguments

Configure inter wireless controller operation in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, wireless_controller_inter_controller, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and inter_controller category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Qos Profile *arguments

Configure WiFi quality of service (QoS) profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_qos_profile, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and qos_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Setting *arguments

VDOM wireless controller configuration in Fortinet's FortiOS and FortiGate.

Arguments: username, host, https, ssl_verify, wireless_controller_setting, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Timers *arguments

Configure CAPWAP timers in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_timers, https, ssl_verify, password, host, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and timers category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Utm Profile *arguments

Configure UTM (Unified Threat Management) profile in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, wireless_controller_utm_profile, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and utm_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Vap *arguments

Configure Virtual Access Points (VAPs) in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_vap, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and vap category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Vap Group *arguments

Configure virtual Access Point (VAP) groups in Fortinet's FortiOS and FortiGate.

Arguments: username, host, wireless_controller_vap_group, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and vap_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Wids Profile *arguments

Configure wireless intrusion detection system (WIDS) profiles in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, wireless_controller_wids_profile, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and wids_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Wtp *arguments

Configure Wireless Termination Points (WTPs), that is, FortiAPs or APs to be managed by FortiGate in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, vdom, https, ssl_verify, password, wireless_controller_wtp

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and wtp category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Wtp Group *arguments

Configure WTP groups in Fortinet's FortiOS and FortiGate.

Arguments: username, wireless_controller_wtp_group, host, state, https, ssl_verify, password, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and wtp_group category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Fortios Wireless Controller Wtp Profile *arguments

Configure WTP profiles or FortiAP profiles that define radio settings for manageable FortiAP platforms in Fortinet's FortiOS and FortiGate.

Arguments: username, host, state, https, ssl_verify, password, wireless_controller_wtp_profile, vdom

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify wireless_controller feature and wtp_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.5

Frr Bgp *arguments

Configure global BGP settings on Free Range Routing(FRR).

Arguments: operation, config

This module provides configuration management of global BGP parameters on devices running Free Range Routing(FRR).

Frr Facts *arguments

Collect facts from remote devices running Free Range Routing (FRR).

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running FRR. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Ftd Configuration *arguments

Manages configuration on Cisco FTD devices over REST API

Arguments: query_params, register_as, filters, path_params, operation, data

Manages configuration on Cisco FTD devices including creating, updating, removing configuration objects, scheduling and staring jobs, deploying pending changes, etc. All operations are performed over REST API.

Ftd File Download *arguments

Downloads files from Cisco FTD devices over HTTP(S)

Arguments: path_params, operation, destination

Downloads files from Cisco FTD devices including pending changes, disk files, certificates, troubleshoot reports, and backups.

Ftd File Upload *arguments

Uploads files to Cisco FTD devices over HTTP(S)

Arguments: register_as, operation, file_to_upload

Uploads files to Cisco FTD devices including disk files, backups, and upgrades.

Ftd Install *arguments

Installs FTD pkg image on the firewall

Arguments: console_username, rommon_file_location, search_domains, image_file_location, device_ip, device_sudo_password, console_port, device_hostname, dns_server, device_new_password, device_username, device_gateway, console_password, device_model, console_ip, device_netmask, image_version, force_install, device_password

Provisioning module for FTD devices that installs ROMMON image (if needed) and FTD pkg image on the firewall. Can be used with httpapi and local connection types. The httpapi is preferred, the local connection should be used only when the device cannot be accessed via REST API.

Gather Facts *arguments

Gathers facts about remote hosts

Arguments: parallel

This module takes care of executing the configured facts modules, the default is to use the M(setup) module. This module is automatically called by playbooks to gather useful variables about remote hosts that can be used in playbooks. It can also be executed directly by C(/usr/bin/ansible) to check what variables are available to a host. Ansible provides many I(facts) about the system, automatically.

Gc Storage *arguments

This module manages objects/buckets in Google Cloud Storage.

Arguments: src, force, permission, dest, gs_access_key, object, bucket, mode, gs_secret_key, expiration, region, versioning, headers

This module allows users to manage their objects/buckets in Google Cloud Storage. It allows upload and download operations and can set some canned permissions. It also allows retrieval of URLs for objects for use in playbooks, and retrieval of string contents of objects. This module requires setting the default project in GCS prior to playbook usage. See U(https://developers.google.com/storage/docs/reference/v1/apiversion1) for information about setting the default project.

Gce Eip *arguments

Create or Destroy Global or Regional External IP addresses.

Arguments: region, name, state

Create (reserve) or Destroy (release) Regional or Global IP Addresses. See U(https://cloud.google.com/compute/docs/configure-instance-ip-addresses#reserve_new_static) for more on reserving static addresses.

Gce Img *arguments

utilize GCE image resources

Arguments: project_id, name, family, service_account_email, pem_file, source, state, timeout, zone, description

This module can create and delete GCE private images from gzipped compressed tarball containing raw disk data or from existing detached disks in any zone. U(https://cloud.google.com/compute/docs/images)

Gce Instance Template *arguments

create or destroy instance templates of Compute Engine of GCP.

Arguments: description, name, tags, automatic_restart, image, service_account_permissions, pem_file, subnetwork_region, disk_type, size, network, external_ip, service_account_email, disks, nic_gce_struct, disk_auto_delete, source, state, disks_gce_struct, credentials_file, image_family, subnetwork, project_id, can_ip_forward, preemptible, metadata

Creates or destroy Google instance templates of Compute Engine of Google Cloud Platform.

Gce Labels *arguments

Create, Update or Destroy GCE Labels.

Arguments: labels, resource_url, resource_name, resource_type, resource_location

Create, Update or Destroy GCE Labels on instances, disks, snapshots, etc. When specifying the GCE resource, users may specify the full URL for the resource (its 'self_link'), or the individual parameters of the resource (type, location, name). Examples for the two options can be seen in the documentation. See U(https://cloud.google.com/compute/docs/label-or-tag-resources) for more information about GCE Labels. Labels are gradually being added to more GCE resources, so this module will need to be updated as new resources are added to the GCE (v1) API.

Gce Lb *arguments

create/destroy GCE load-balancer resources

Arguments: httphealthcheck_host, protocol, pem_file, members, httphealthcheck_port, httphealthcheck_name, name, external_ip, service_account_email, region, httphealthcheck_unhealthy_count, httphealthcheck_healthy_count, httphealthcheck_path, port_range, state, httphealthcheck_timeout, credentials_file, project_id, httphealthcheck_interval

This module can create and destroy Google Compute Engine C(loadbalancer) and C(httphealthcheck) resources. The primary LB resource is the C(load_balancer) resource and the health check parameters are all prefixed with I(httphealthcheck). The full documentation for Google Compute Engine load balancing is at U(https://developers.google.com/compute/docs/load-balancing/). However, the ansible module simplifies the configuration by following the libcloud model. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Gce Mig *arguments

Create, Update or Destroy a Managed Instance Group (MIG).

Arguments: name, zone, service_account_email, autoscaling, named_ports, state, template, credentials_file, project_id, size

Create, Update or Destroy a Managed Instance Group (MIG). See U(https://cloud.google.com/compute/docs/instance-groups) for an overview. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Gce Net *arguments

create/destroy GCE networks and firewall rules

Arguments: src_tags, subnet_region, ipv4_range, pem_file, target_tags, allowed, fwname, name, src_range, state, subnet_name, mode, credentials_file, service_account_email, project_id, subnet_desc

This module can create and destroy Google Compute Engine networks and firewall rules U(https://cloud.google.com/compute/docs/networking). The I(name) parameter is reserved for referencing a network while the I(fwname) parameter is used to reference firewall rules. IPv4 Address ranges must be specified using the CIDR U(http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) format. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Gce Pd *arguments

utilize GCE persistent disk resources

Arguments: size_gb, project_id, name, zone, service_account_email, image, pem_file, instance_name, state, snapshot, detach_only, credentials_file, disk_type, delete_on_termination, mode

This module can create and destroy unformatted GCE persistent disks U(https://developers.google.com/compute/docs/disks#persistentdisks). It also supports attaching and detaching disks from running instances. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.

Gce Snapshot *arguments

Create or destroy snapshots for GCE storage volumes

Arguments: instance_name, project_id, state, snapshot_name, credentials_file, service_account_email, disks

Manages snapshots for GCE instances. This module manages snapshots for the storage volumes of a GCE compute instance. If there are multiple volumes, each snapshot will be prepended with the disk name

Gce Tag *arguments

add or remove tag(s) to/from GCE instances

Arguments: zone, tags, service_account_email, pem_file, instance_name, state, instance_pattern, project_id

This module can add or remove tags U(https://cloud.google.com/compute/docs/label-or-tag-resources#tags) to/from GCE instances. Use 'instance_pattern' to update multiple instances in a specify zone.

Gconftool 2 *arguments

Edit GNOME Configurations

Arguments: state, value_type, key, direct, value, config_source

This module allows for the manipulation of GNOME 2 Configuration via gconftool-2. Please see the gconftool-2(1) man pages for more details.

Gcp Appengine Firewall Rule *arguments

Creates a GCP FirewallRule

Arguments: action, priority, state, description, source_range

A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.

Gcp Appengine Firewall Rule Info *arguments

Gather info for GCP FirewallRule

Arguments:

Gather info for GCP FirewallRule

Gcp Bigquery Dataset *arguments

Creates a GCP Dataset

Arguments: default_partition_expiration_ms, name, default_table_expiration_ms, labels, friendly_name, access, state, location, dataset_reference, description

Datasets allow you to organize and control access to your tables.

Gcp Bigquery Dataset Info *arguments

Gather info for GCP Dataset

Arguments:

Gather info for GCP Dataset This module was called C(gcp_bigquery_dataset_facts) before Ansible 2.9. The usage has not changed.

Gcp Bigquery Table *arguments

Creates a GCP Table

Arguments: clustering, table_reference, name, encryption_configuration, description, labels, friendly_name, dataset, external_data_configuration, state, num_rows, time_partitioning, expiration_time, view, schema

A Table that belongs to a Dataset .

Gcp Bigquery Table Info *arguments

Gather info for GCP Table

Arguments: dataset

Gather info for GCP Table This module was called C(gcp_bigquery_table_facts) before Ansible 2.9. The usage has not changed.

Gcp Cloudbuild Trigger *arguments

Creates a GCP Trigger

Arguments: description, ignored_files, filename, disabled, state, build, included_files, substitutions, id, trigger_template

Configuration for an automated build in response to source repository changes.

Gcp Cloudbuild Trigger Info *arguments

Gather info for GCP Trigger

Arguments:

Gather info for GCP Trigger This module was called C(gcp_cloudbuild_trigger_facts) before Ansible 2.9. The usage has not changed.

Gcp Cloudfunctions Cloud Function *arguments

Creates a GCP CloudFunction

Arguments: labels, available_memory_mb, https_trigger, entry_point, source_archive_url, source_upload_url, description, name, source_repository, trigger_http, state, location, timeout, environment_variables, runtime, event_trigger

A Cloud Function that contains user computation executed in response to an event.

Gcp Cloudfunctions Cloud Function Info *arguments

Gather info for GCP CloudFunction

Arguments: location

Gather info for GCP CloudFunction

Gcp Cloudscheduler Job *arguments

Creates a GCP Job

Arguments: app_engine_http_target, name, schedule, region, http_target, time_zone, state, pubsub_target, retry_config, description

A scheduled job that can publish a pubsub message or a http request every X interval of time, using crontab format string. To use Cloud Scheduler your project must contain an App Engine app that is located in one of the supported regions. If your project does not have an App Engine app, you must create one.

Gcp Cloudscheduler Job Info *arguments

Gather info for GCP Job

Arguments: region

Gather info for GCP Job

Gcp Cloudtasks Queue *arguments

Creates a GCP Queue

Arguments: status, state, name, rate_limits, retry_config, app_engine_routing_override, location

A named resource to which messages are sent by publishers.

Gcp Cloudtasks Queue Info *arguments

Gather info for GCP Queue

Arguments: location

Gather info for GCP Queue

Gcp Compute Address *arguments

Creates a GCP Address

Arguments: description, region, state, network_tier, address, subnetwork, address_type, name

Represents an Address resource. Each virtual machine instance has an ephemeral internal IP address and, optionally, an external IP address. To communicate between instances on the same network, you can use an instance's internal IP address. To communicate with the Internet and instances outside of the same network, you must specify the instance's external IP address. Internal IP addresses are ephemeral and only belong to an instance for the lifetime of the instance; if the instance is deleted and recreated, the instance is assigned a new internal IP address, either by Compute Engine or by you. External IP addresses can be either ephemeral or static.

Gcp Compute Address Info *arguments

Gather info for GCP Address

Arguments: region, filters

Gather info for GCP Address This module was called C(gcp_compute_address_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Autoscaler *arguments

Creates a GCP Autoscaler

Arguments: state, target, zone, name, autoscaling_policy, description

Represents an Autoscaler resource. Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define.

Gcp Compute Autoscaler Info *arguments

Gather info for GCP Autoscaler

Arguments: filters, zone

Gather info for GCP Autoscaler

Gcp Compute Backend Bucket *arguments

Creates a GCP BackendBucket

Arguments: state, bucket_name, description, enable_cdn, cdn_policy, name

Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S) load balancing. An HTTP(S) load balancer can direct traffic to specified URLs to a backend bucket rather than a backend service. It can send requests for static content to a Cloud Storage bucket and requests for dynamic content a virtual machine instance.

Gcp Compute Backend Bucket Info *arguments

Gather info for GCP BackendBucket

Arguments: filters

Gather info for GCP BackendBucket This module was called C(gcp_compute_backend_bucket_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Backend Service *arguments

Creates a GCP BackendService

Arguments: protocol, description, timeout_sec, health_checks, port_name, enable_cdn, cdn_policy, session_affinity, security_policy, load_balancing_scheme, name, affinity_cookie_ttl_sec, connection_draining, state, backends, iap

A Backend Service defines a group of virtual machines that will serve traffic for load balancing. This resource is a global backend service, appropriate for external load balancing or self-managed internal load balancing. For managed internal load balancing, use a regional backend service instead. Currently self-managed internal load balancing is only available in beta.

Gcp Compute Backend Service Info *arguments

Gather info for GCP BackendService

Arguments: filters

Gather info for GCP BackendService This module was called C(gcp_compute_backend_service_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Disk *arguments

Creates a GCP Disk

Arguments: size_gb, type, description, zone, source_snapshot_encryption_key, labels, state, source_snapshot, licenses, disk_encryption_key, source_image_encryption_key, source_image, physical_block_size_bytes, name

Persistent disks are durable storage devices that function similarly to the physical disks in a desktop or a server. Compute Engine manages the hardware behind these devices to ensure data redundancy and optimize performance for you. Persistent disks are available as either standard hard disk drives (HDD) or solid-state drives (SSD). Persistent disks are located independently from your virtual machine instances, so you can detach or move persistent disks to keep your data even after you delete your instances. Persistent disk performance scales automatically with size, so you can resize your existing persistent disks or add more persistent disks to an instance to meet your performance and storage space requirements. Add a persistent disk to your instance when you need reliable and affordable storage with consistent performance characteristics.

Gcp Compute Disk Info *arguments

Gather info for GCP Disk

Arguments: filters, zone

Gather info for GCP Disk This module was called C(gcp_compute_disk_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Firewall *arguments

Creates a GCP Firewall

Arguments: disabled, direction, source_ranges, description, source_tags, target_service_accounts, destination_ranges, state, name, priority, target_tags, source_service_accounts, allowed, denied, network

Each network has its own firewall controlling access to and from the instances. All traffic to instances, even from other instances, is blocked by the firewall unless firewall rules are created to allow it. The default network has automatically created firewall rules that are shown in default firewall rules. No manually created network has automatically created firewall rules except for a default "allow" rule for outgoing traffic and a default "deny" for incoming traffic. For all networks except the default network, you must create any firewall rules you need.

Gcp Compute Firewall Info *arguments

Gather info for GCP Firewall

Arguments: filters

Gather info for GCP Firewall This module was called C(gcp_compute_firewall_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Forwarding Rule *arguments

Creates a GCP ForwardingRule

Arguments: description, ip_protocol, load_balancing_scheme, network_tier, ip_address, network, backend_service, name, region, service_label, port_range, state, all_ports, target, ip_version, subnetwork, ports

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.

Gcp Compute Forwarding Rule Info *arguments

Gather info for GCP ForwardingRule

Arguments: region, filters

Gather info for GCP ForwardingRule This module was called C(gcp_compute_forwarding_rule_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Global Address *arguments

Creates a GCP GlobalAddress

Arguments: description, name, state, purpose, prefix_length, address, ip_version, address_type, network

Represents a Global Address resource. Global addresses are used for HTTP(S) load balancing.

Gcp Compute Global Address Info *arguments

Gather info for GCP GlobalAddress

Arguments: filters

Gather info for GCP GlobalAddress This module was called C(gcp_compute_global_address_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Global Forwarding Rule *arguments

Creates a GCP GlobalForwardingRule

Arguments: load_balancing_scheme, description, ip_protocol, port_range, state, target, ip_version, ip_address, network, name

Represents a GlobalForwardingRule resource. Global forwarding rules are used to forward traffic to the correct load balancer for HTTP load balancing. Global forwarding rules can only be used for HTTP load balancing. For more information, see U(https://cloud.google.com/compute/docs/load-balancing/http/) .

Gcp Compute Global Forwarding Rule Info *arguments

Gather info for GCP GlobalForwardingRule

Arguments: filters

Gather info for GCP GlobalForwardingRule This module was called C(gcp_compute_global_forwarding_rule_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Health Check *arguments

Creates a GCP HealthCheck

Arguments: check_interval_sec, description, name, timeout_sec, healthy_threshold, state, unhealthy_threshold, http_health_check, ssl_health_check, tcp_health_check, type, https_health_check

Health Checks determine whether instances are responsive and able to do work. They are an important part of a comprehensive load balancing configuration, as they enable monitoring instances behind load balancers. Health Checks poll instances at a specified interval. Instances that do not respond successfully to some number of probes in a row are marked as unhealthy. No new connections are sent to unhealthy instances, though existing connections will continue. The health check will continue to poll unhealthy instances. If an instance later responds successfully to some number of consecutive probes, it is marked healthy again and can receive new connections.

Gcp Compute Health Check Info *arguments

Gather info for GCP HealthCheck

Arguments: filters

Gather info for GCP HealthCheck This module was called C(gcp_compute_health_check_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Http Health Check *arguments

Creates a GCP HttpHealthCheck

Arguments: check_interval_sec, description, name, timeout_sec, healthy_threshold, host, unhealthy_threshold, state, port, request_path

An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.

Gcp Compute Http Health Check Info *arguments

Gather info for GCP HttpHealthCheck

Arguments: filters

Gather info for GCP HttpHealthCheck This module was called C(gcp_compute_http_health_check_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Https Health Check *arguments

Creates a GCP HttpsHealthCheck

Arguments: check_interval_sec, description, name, timeout_sec, healthy_threshold, host, unhealthy_threshold, state, port, request_path

An HttpsHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTPS.

Gcp Compute Https Health Check Info *arguments

Gather info for GCP HttpsHealthCheck

Arguments: filters

Gather info for GCP HttpsHealthCheck This module was called C(gcp_compute_https_health_check_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Image *arguments

Creates a GCP Image

Arguments: source_disk, disk_size_gb, description, family, labels, guest_os_features, image_encryption_key, raw_disk, name, source_type, state, source_disk_encryption_key, licenses, source_disk_id

Represents an Image resource. Google Compute Engine uses operating system images to create the root persistent disks for your instances. You specify an image when you create an instance. Images contain a boot loader, an operating system, and a root file system. Linux operating system images are also capable of running containers on Compute Engine. Images can be either public or custom. Public images are provided and maintained by Google, open-source communities, and third-party vendors. By default, all projects have access to these images and can use them to create instances. Custom images are available only to your project. You can create a custom image from root persistent disks and other images. Then, use the custom image to create an instance.

Gcp Compute Image Info *arguments

Gather info for GCP Image

Arguments: filters

Gather info for GCP Image This module was called C(gcp_compute_image_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Instance *arguments

Creates a GCP Instance

Arguments: status, hostname, can_ip_forward, tags, service_accounts, labels, guest_accelerators, deletion_protection, machine_type, shielded_instance_config, scheduling, network_interfaces, name, zone, disks, state, min_cpu_platform, metadata

An instance is a virtual machine (VM) hosted on Google's infrastructure.

Gcp Compute Instance Group *arguments

Creates a GCP InstanceGroup

Arguments: description, zone, named_ports, region, instances, state, subnetwork, network, name

Represents an Instance Group resource. Instance groups are self-managed and can contain identical or different instances. Instance groups do not use an instance template. Unlike managed instance groups, you must create and add instances to an instance group manually.

Gcp Compute Instance Group Info *arguments

Gather info for GCP InstanceGroup

Arguments: filters, zone

Gather info for GCP InstanceGroup This module was called C(gcp_compute_instance_group_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Instance Group Manager *arguments

Creates a GCP InstanceGroupManager

Arguments: instance_template, description, zone, base_instance_name, state, name, named_ports, target_size, target_pools

Creates a managed instance group using the information that you specify in the request. After the group is created, it schedules an action to create instances in the group using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances. A managed instance group can have up to 1000 VM instances per group.

Gcp Compute Instance Group Manager Info *arguments

Gather info for GCP InstanceGroupManager

Arguments: filters, zone

Gather info for GCP InstanceGroupManager This module was called C(gcp_compute_instance_group_manager_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Instance Info *arguments

Gather info for GCP Instance

Arguments: filters, zone

Gather info for GCP Instance This module was called C(gcp_compute_instance_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Instance Template *arguments

Creates a GCP InstanceTemplate

Arguments: state, properties, name, description

Defines an Instance Template resource that provides configuration settings for your virtual machine instances. Instance templates are not tied to the lifetime of an instance and can be used and reused as to deploy virtual machines. You can also use different templates to create different virtual machine configurations. Instance templates are required when you create a managed instance group. Tip: Disks should be set to autoDelete=true so that leftover disks are not left behind on machine deletion.

Gcp Compute Instance Template Info *arguments

Gather info for GCP InstanceTemplate

Arguments: filters

Gather info for GCP InstanceTemplate This module was called C(gcp_compute_instance_template_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Interconnect Attachment *arguments

Creates a GCP InterconnectAttachment

Arguments: edge_availability_domain, interconnect, description, state, region, candidate_subnets, bandwidth, vlan_tag8021q, router, type, admin_enabled, name

Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments.

Gcp Compute Interconnect Attachment Info *arguments

Gather info for GCP InterconnectAttachment

Arguments: region, filters

Gather info for GCP InterconnectAttachment This module was called C(gcp_compute_interconnect_attachment_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Network *arguments

Creates a GCP Network

Arguments: state, description, name, ipv4_range, routing_config, auto_create_subnetworks

Manages a VPC network or legacy network resource on GCP.

Gcp Compute Network Info *arguments

Gather info for GCP Network

Arguments: filters

Gather info for GCP Network This module was called C(gcp_compute_network_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Region Disk *arguments

Creates a GCP RegionDisk

Arguments: size_gb, description, source_snapshot, region, labels, state, type, licenses, disk_encryption_key, source_snapshot_encryption_key, replica_zones, physical_block_size_bytes, name

Persistent disks are durable storage devices that function similarly to the physical disks in a desktop or a server. Compute Engine manages the hardware behind these devices to ensure data redundancy and optimize performance for you. Persistent disks are available as either standard hard disk drives (HDD) or solid-state drives (SSD). Persistent disks are located independently from your virtual machine instances, so you can detach or move persistent disks to keep your data even after you delete your instances. Persistent disk performance scales automatically with size, so you can resize your existing persistent disks or add more persistent disks to an instance to meet your performance and storage space requirements. Add a persistent disk to your instance when you need reliable and affordable storage with consistent performance characteristics.

Gcp Compute Region Disk Info *arguments

Gather info for GCP RegionDisk

Arguments: region, filters

Gather info for GCP RegionDisk This module was called C(gcp_compute_region_disk_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Route *arguments

Creates a GCP Route

Arguments: dest_range, network, next_hop_instance, tags, description, next_hop_gateway, state, priority, next_hop_ip, next_hop_vpn_tunnel, name

Represents a Route resource. A route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with virtual machines by tag, and the set of routes for a particular virtual machine is called its routing table. For each packet leaving a virtual machine, the system searches that virtual machine's routing table for a single best matching route. Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the next_hop field of the winning route -- either to another virtual machine destination, a virtual machine gateway or a Compute Engine-operated gateway. Packets that do not match any route in the sending virtual machine's routing table will be dropped. A Route resource must have exactly one specification of either nextHopGateway, nextHopInstance, nextHopIp, or nextHopVpnTunnel.

Gcp Compute Route Info *arguments

Gather info for GCP Route

Arguments: filters

Gather info for GCP Route This module was called C(gcp_compute_route_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Router *arguments

Creates a GCP Router

Arguments: bgp, state, network, name, region, description

Represents a Router resource.

Gcp Compute Router Info *arguments

Gather info for GCP Router

Arguments: region, filters

Gather info for GCP Router This module was called C(gcp_compute_router_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Snapshot *arguments

Creates a GCP Snapshot

Arguments: source_disk, name, zone, description, labels, state, snapshot_encryption_key, source_disk_encryption_key

Represents a Persistent Disk Snapshot resource. Use snapshots to back up data from your persistent disks. Snapshots are different from public images and custom images, which are used primarily to create instances or configure instance templates. Snapshots are useful for periodic backup of the data on your persistent disks. You can create snapshots from persistent disks even while they are attached to running instances. Snapshots are incremental, so you can create regular snapshots on a persistent disk faster and at a much lower cost than if you regularly created a full image of the disk.

Gcp Compute Snapshot Info *arguments

Gather info for GCP Snapshot

Arguments: filters

Gather info for GCP Snapshot

Gcp Compute Ssl Certificate *arguments

Creates a GCP SslCertificate

Arguments: name, private_key, state, certificate, description

An SslCertificate resource, used for HTTPS load balancing. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.

Gcp Compute Ssl Certificate Info *arguments

Gather info for GCP SslCertificate

Arguments: filters

Gather info for GCP SslCertificate This module was called C(gcp_compute_ssl_certificate_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Ssl Policy *arguments

Creates a GCP SslPolicy

Arguments: profile, state, description, custom_features, min_tls_version, name

Represents a SSL policy. SSL policies give you the ability to control the features of SSL that your SSL proxy or HTTPS load balancer negotiates.

Gcp Compute Ssl Policy Info *arguments

Gather info for GCP SslPolicy

Arguments: filters

Gather info for GCP SslPolicy This module was called C(gcp_compute_ssl_policy_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Subnetwork *arguments

Creates a GCP Subnetwork

Arguments: network, private_ip_google_access, region, description, state, enable_flow_logs, secondary_ip_ranges, ip_cidr_range, name

A VPC network is a virtual version of the traditional physical networks that exist within and between physical data centers. A VPC network provides connectivity for your Compute Engine virtual machine (VM) instances, Container Engine containers, App Engine Flex services, and other network-related resources. Each GCP project contains one or more VPC networks. Each VPC network is a global entity spanning all GCP regions. This global VPC network allows VM instances and other resources to communicate with each other via internal, private IP addresses. Each VPC network is subdivided into subnets, and each subnet is contained within a single region. You can have more than one subnet in a region for a given VPC network. Each subnet has a contiguous private RFC1918 IP space. You create instances, containers, and the like in these subnets. When you create an instance, you must create it in a subnet, and the instance draws its internal IP address from that subnet. Virtual machine (VM) instances in a VPC network can communicate with instances in all other subnets of the same VPC network, regardless of region, using their RFC1918 private IP addresses. You can isolate portions of the network, even entire subnets, using firewall rules.

Gcp Compute Subnetwork Info *arguments

Gather info for GCP Subnetwork

Arguments: region, filters

Gather info for GCP Subnetwork This module was called C(gcp_compute_subnetwork_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Target Http Proxy *arguments

Creates a GCP TargetHttpProxy

Arguments: state, url_map, description, name

Represents a TargetHttpProxy resource, which is used by one or more global forwarding rule to route incoming HTTP requests to a URL map.

Gcp Compute Target Http Proxy Info *arguments

Gather info for GCP TargetHttpProxy

Arguments: filters

Gather info for GCP TargetHttpProxy This module was called C(gcp_compute_target_http_proxy_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Target Https Proxy *arguments

Creates a GCP TargetHttpsProxy

Arguments: state, ssl_policy, ssl_certificates, description, url_map, quic_override, name

Represents a TargetHttpsProxy resource, which is used by one or more global forwarding rule to route incoming HTTPS requests to a URL map.

Gcp Compute Target Https Proxy Info *arguments

Gather info for GCP TargetHttpsProxy

Arguments: filters

Gather info for GCP TargetHttpsProxy This module was called C(gcp_compute_target_https_proxy_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Target Pool *arguments

Creates a GCP TargetPool

Arguments: health_check, failover_ratio, description, region, name, backup_pool, instances, state, session_affinity

Represents a TargetPool resource, used for Load Balancing.

Gcp Compute Target Pool Info *arguments

Gather info for GCP TargetPool

Arguments: region, filters

Gather info for GCP TargetPool This module was called C(gcp_compute_target_pool_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Target Ssl Proxy *arguments

Creates a GCP TargetSslProxy

Arguments: state, proxy_header, ssl_policy, service, ssl_certificates, name, description

Represents a TargetSslProxy resource, which is used by one or more global forwarding rule to route incoming SSL requests to a backend service.

Gcp Compute Target Ssl Proxy Info *arguments

Gather info for GCP TargetSslProxy

Arguments: filters

Gather info for GCP TargetSslProxy This module was called C(gcp_compute_target_ssl_proxy_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Target Tcp Proxy *arguments

Creates a GCP TargetTcpProxy

Arguments: state, proxy_header, description, service, name

Represents a TargetTcpProxy resource, which is used by one or more global forwarding rule to route incoming TCP requests to a Backend service.

Gcp Compute Target Tcp Proxy Info *arguments

Gather info for GCP TargetTcpProxy

Arguments: filters

Gather info for GCP TargetTcpProxy This module was called C(gcp_compute_target_tcp_proxy_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Target Vpn Gateway *arguments

Creates a GCP TargetVpnGateway

Arguments: region, state, network, name, description

Represents a VPN gateway running in GCP. This virtual device is managed by Google, but used only by you.

Gcp Compute Target Vpn Gateway Info *arguments

Gather info for GCP TargetVpnGateway

Arguments: region, filters

Gather info for GCP TargetVpnGateway This module was called C(gcp_compute_target_vpn_gateway_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Url Map *arguments

Creates a GCP UrlMap

Arguments: host_rules, default_service, tests, description, path_matchers, state, name

UrlMaps are used to route requests to a backend service based on rules that you define for the host and path of an incoming URL.

Gcp Compute Url Map Info *arguments

Gather info for GCP UrlMap

Arguments: filters

Gather info for GCP UrlMap This module was called C(gcp_compute_url_map_facts) before Ansible 2.9. The usage has not changed.

Gcp Compute Vpn Tunnel *arguments

Creates a GCP VpnTunnel

Arguments: remote_traffic_selector, name, region, description, peer_ip, state, target_vpn_gateway, shared_secret, router, ike_version, local_traffic_selector

VPN tunnel resource.

Gcp Compute Vpn Tunnel Info *arguments

Gather info for GCP VpnTunnel

Arguments: region, filters

Gather info for GCP VpnTunnel This module was called C(gcp_compute_vpn_tunnel_facts) before Ansible 2.9. The usage has not changed.

Gcp Container Cluster *arguments

Creates a GCP Cluster

Arguments: initial_node_count, tpu_ipv4_cidr_block, kubectl_context, cluster_ipv4_cidr, ip_allocation_policy, enable_tpu, master_auth, locations, network_policy, node_config, resource_labels, addons_config, monitoring_service, private_cluster_config, description, kubectl_path, legacy_abac, name, network, state, default_max_pods_constraint, location, subnetwork, logging_service

A Google Container Engine cluster.

Gcp Container Cluster Info *arguments

Gather info for GCP Cluster

Arguments: location

Gather info for GCP Cluster This module was called C(gcp_container_cluster_facts) before Ansible 2.9. The usage has not changed.

Gcp Container Node Pool *arguments

Creates a GCP NodePool

Arguments: initial_node_count, management, name, config, autoscaling, state, cluster, max_pods_constraint, version, location, conditions

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Gcp Container Node Pool Info *arguments

Gather info for GCP NodePool

Arguments: cluster, location

Gather info for GCP NodePool This module was called C(gcp_container_node_pool_facts) before Ansible 2.9. The usage has not changed.

Gcp Dns Managed Zone *arguments

Creates a GCP ManagedZone

Arguments: description, name_server_set, dnssec_config, dns_name, labels, private_visibility_config, visibility, state, name

A zone is a subtree of the DNS namespace under one administrative responsibility. A ManagedZone is a resource that represents a DNS zone hosted by the Cloud DNS service.

Gcp Dns Managed Zone Info *arguments

Gather info for GCP ManagedZone

Arguments: dns_name

Gather info for GCP ManagedZone This module was called C(gcp_dns_managed_zone_facts) before Ansible 2.9. The usage has not changed.

Gcp Dns Resource Record Set *arguments

Creates a GCP ResourceRecordSet

Arguments: state, target, ttl, managed_zone, type, name

A single DNS record that exists on a domain name (i.e. in a managed zone). This record defines the information about the domain and where the domain / subdomains direct to. The record will include the domain/subdomain name, a type (i.e. A, AAA, CAA, MX, CNAME, NS, etc) .

Gcp Dns Resource Record Set Info *arguments

Gather info for GCP ResourceRecordSet

Arguments: managed_zone

Gather info for GCP ResourceRecordSet This module was called C(gcp_dns_resource_record_set_facts) before Ansible 2.9. The usage has not changed.

Gcp Filestore Instance *arguments

Creates a GCP Instance

Arguments: name, zone, file_shares, labels, state, tier, networks, description

A Google Cloud Filestore instance.

Gcp Filestore Instance Info *arguments

Gather info for GCP Instance

Arguments: zone

Gather info for GCP Instance

Gcp Iam Role *arguments

Creates a GCP Role

Arguments: state, description, name, title, included_permissions, stage

A role in the Identity and Access Management API .

Gcp Iam Role Info *arguments

Gather info for GCP Role

Arguments:

Gather info for GCP Role This module was called C(gcp_iam_role_facts) before Ansible 2.9. The usage has not changed.

Gcp Iam Service Account *arguments

Creates a GCP ServiceAccount

Arguments: state, display_name, name

A service account in the Identity and Access Management API.

Gcp Iam Service Account Info *arguments

Gather info for GCP ServiceAccount

Arguments:

Gather info for GCP ServiceAccount This module was called C(gcp_iam_service_account_facts) before Ansible 2.9. The usage has not changed.

Gcp Iam Service Account Key *arguments

Creates a GCP ServiceAccountKey

Arguments: path, state, private_key_type, key_algorithm, service_account

A service account in the Identity and Access Management API.

Gcp Kms Crypto Key *arguments

Creates a GCP CryptoKey

Arguments: state, version_template, key_ring, rotation_period, labels, name, purpose

A CryptoKey represents a logical key that can be used for cryptographic operations.

Gcp Kms Crypto Key Info *arguments

Gather info for GCP CryptoKey

Arguments: key_ring

Gather info for GCP CryptoKey

Gcp Kms Key Ring *arguments

Creates a GCP KeyRing

Arguments: state, name, location

A KeyRing is a toplevel logical grouping of CryptoKeys.

Gcp Kms Key Ring Info *arguments

Gather info for GCP KeyRing

Arguments: location

Gather info for GCP KeyRing

Gcp Mlengine Model *arguments

Creates a GCP Model

Arguments: default_version, name, labels, regions, state, online_prediction_console_logging, online_prediction_logging, description

Represents a machine learning solution. A model can have multiple versions, each of which is a deployed, trained model ready to receive prediction requests. The model itself is just a container.

Gcp Mlengine Model Info *arguments

Gather info for GCP Model

Arguments:

Gather info for GCP Model

Gcp Mlengine Version *arguments

Creates a GCP Version

Arguments: description, auto_scaling, name, manual_scaling, labels, service_account, is_default, framework, state, runtime_version, deployment_uri, model, machine_type, prediction_class, python_version

Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions .

Gcp Mlengine Version Info *arguments

Gather info for GCP Version

Arguments: model

Gather info for GCP Version

Gcp Pubsub Subscription *arguments

Creates a GCP Subscription

Arguments: ack_deadline_seconds, message_retention_duration, name, push_config, labels, topic, state, retain_acked_messages, expiration_policy

A named resource representing the stream of messages from a single, specific topic, to be delivered to the subscribing application.

Gcp Pubsub Subscription Info *arguments

Gather info for GCP Subscription

Arguments:

Gather info for GCP Subscription This module was called C(gcp_pubsub_subscription_facts) before Ansible 2.9. The usage has not changed.

Gcp Pubsub Topic *arguments

Creates a GCP Topic

Arguments: kms_key_name, state, labels, name, message_storage_policy

A named resource to which messages are sent by publishers.

Gcp Pubsub Topic Info *arguments

Gather info for GCP Topic

Arguments:

Gather info for GCP Topic This module was called C(gcp_pubsub_topic_facts) before Ansible 2.9. The usage has not changed.

Gcp Redis Instance *arguments

Creates a GCP Instance

Arguments: redis_configs, name, region, labels, memory_size_gb, state, reserved_ip_range, tier, alternative_location_id, location_id, redis_version, authorized_network, display_name

A Google Cloud Redis instance.

Gcp Redis Instance Info *arguments

Gather info for GCP Instance

Arguments: region

Gather info for GCP Instance This module was called C(gcp_redis_instance_facts) before Ansible 2.9. The usage has not changed.

Gcp Resourcemanager Project *arguments

Creates a GCP Project

Arguments: state, labels, name, parent, id

Represents a GCP Project. A project is a container for ACLs, APIs, App Engine Apps, VMs, and other Google Cloud Platform resources.

Gcp Resourcemanager Project Info *arguments

Gather info for GCP Project

Arguments:

Gather info for GCP Project This module was called C(gcp_resourcemanager_project_facts) before Ansible 2.9. The usage has not changed.

Gcp Sourcerepo Repository *arguments

Creates a GCP Repository

Arguments: state, name

A repository (or repo) is a Git repository storing versioned source content.

Gcp Sourcerepo Repository Info *arguments

Gather info for GCP Repository

Arguments:

Gather info for GCP Repository This module was called C(gcp_sourcerepo_repository_facts) before Ansible 2.9. The usage has not changed.

Gcp Spanner Database *arguments

Creates a GCP Database

Arguments: instance, state, extra_statements, name

A Cloud Spanner Database which is hosted on a Spanner instance.

Gcp Spanner Database Info *arguments

Gather info for GCP Database

Arguments: instance

Gather info for GCP Database This module was called C(gcp_spanner_database_facts) before Ansible 2.9. The usage has not changed.

Gcp Spanner Instance *arguments

Creates a GCP Instance

Arguments: state, display_name, name, node_count, labels, config

An isolated set of Cloud Spanner resources on which databases can be hosted.

Gcp Spanner Instance Info *arguments

Gather info for GCP Instance

Arguments:

Gather info for GCP Instance This module was called C(gcp_spanner_instance_facts) before Ansible 2.9. The usage has not changed.

Gcp Sql Database *arguments

Creates a GCP Database

Arguments: collation, instance, state, charset, name

Represents a SQL database inside the Cloud SQL instance, hosted in Google's cloud.

Gcp Sql Database Info *arguments

Gather info for GCP Database

Arguments: instance

Gather info for GCP Database This module was called C(gcp_sql_database_facts) before Ansible 2.9. The usage has not changed.

Gcp Sql Instance *arguments

Creates a GCP Instance

Arguments: ipv6_address, backend_type, name, master_instance_name, settings, region, connection_name, max_disk_size, instance_type, state, database_version, failover_replica, replica_configuration

Represents a Cloud SQL instance. Cloud SQL instances are SQL databases hosted in Google's cloud. The Instances resource provides methods for common configuration and management tasks.

Gcp Sql Instance Info *arguments

Gather info for GCP Instance

Arguments:

Gather info for GCP Instance This module was called C(gcp_sql_instance_facts) before Ansible 2.9. The usage has not changed.

Gcp Sql User *arguments

Creates a GCP User

Arguments: instance, state, password, host, name

The Users resource represents a database user in a Cloud SQL instance.

Gcp Sql User Info *arguments

Gather info for GCP User

Arguments: instance

Gather info for GCP User This module was called C(gcp_sql_user_facts) before Ansible 2.9. The usage has not changed.

Gcp Storage Bucket *arguments

Creates a GCP Bucket

Arguments: website, logging, name, metageneration, predefined_default_object_acl, acl, project, state, storage_class, default_object_acl, location, cors, owner, lifecycle, versioning

The Buckets resource represents a bucket in Google Cloud Storage. There is a single global namespace shared by all buckets. For more information, see Bucket Name Requirements. Buckets contain objects which can be accessed by their own methods. In addition to the acl property, buckets contain bucketAccessControls, for use in fine-grained manipulation of an existing bucket's access controls. A bucket is always owned by the project team owners group.

Gcp Storage Bucket Access Control *arguments

Creates a GCP BucketAccessControl

Arguments: project_team, entity_id, role, bucket, state, entity

The BucketAccessControls resource represents the Access Control Lists (ACLs) for buckets within Google Cloud Storage. ACLs let you specify who has access to your data and to what extent. There are three roles that can be assigned to an entity: READERs can get the bucket, though no acl property will be returned, and list the bucket's objects. WRITERs are READERs, and they can insert objects into the bucket and delete the bucket's objects. OWNERs are WRITERs, and they can get the acl property of a bucket, update a bucket, and call all BucketAccessControls methods on the bucket. For more information, see Access Control, with the caveat that this API uses READER, WRITER, and OWNER instead of READ, WRITE, and FULL_CONTROL.

Gcp Storage Object *arguments

Creates a GCP Object

Arguments: src, state, dest, bucket, action, overwrite

Upload or download a file from a GCS bucket.

Gcp Tpu Node *arguments

Creates a GCP Node

Arguments: name, zone, tensorflow_version, labels, state, accelerator_type, network, scheduling_config, cidr_block, description

A Cloud TPU instance.

Gcp Tpu Node Info *arguments

Gather info for GCP Node

Arguments: zone

Gather info for GCP Node

Gcpubsub *arguments

Create and Delete Topics/Subscriptions, Publish and pull messages on PubSub

Arguments: pull, ack_deadline, name, publish, topic, state, push_endpoint, subscription

Create and Delete Topics/Subscriptions, Publish and pull messages on PubSub. See U(https://cloud.google.com/pubsub/docs) for an overview.

Gcpubsub Info *arguments

List Topics/Subscriptions and Messages from Google PubSub.

Arguments: topic, state, view

List Topics/Subscriptions from Google PubSub. Use the gcpubsub module for topic/subscription management. See U(https://cloud.google.com/pubsub/docs) for an overview. This module was called C(gcpubsub_facts) before Ansible 2.9. The usage did not change.

Gem *arguments

Manage Ruby gems

Arguments: include_dependencies, executable, force, name, repository, build_flags, include_doc, user_install, pre_release, env_shebang, install_dir, state, version, gem_source

Manage installation and uninstallation of Ruby gems.

Get Certificate *arguments

Get a certificate from a host:port

Arguments: proxy_port, host, timeout, ca_cert, proxy_host, select_crypto_backend, port

Makes a secure connection and returns information about the presented certificate The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available. This can be overridden with the I(select_crypto_backend) option. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13."

Get Url *arguments

Downloads files from HTTP, HTTPS, or FTP to node

Arguments: backup, force, url_username, dest, force_basic_auth, sha256sum, http_agent, client_key, url_password, use_proxy, url, checksum, headers, timeout, validate_certs, client_cert, tmp_dest

Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server I(must) have direct access to the remote resource. By default, if an environment variable C(<protocol>_proxy) is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment <https://docs.ansible.com/playbooks_environment.html>_), or by using the use_proxy option. HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct. From Ansible 2.4 when run with C(--check), it will do a HEAD request to validate the URL but will not download the entire file or verify it against hashes. For Windows targets, use the M(win_get_url) module instead.

Getent *arguments

A wrapper to the unix getent utility

Arguments: fail_key, key, split, service, database

Runs getent against one of it's various databases and returns information into the host's facts, in a getent_<database> prefixed variable.

Git *arguments

Deploy software (or files) from git checkouts

Arguments: force, track_submodules, reference, dest, umask, clone, gpg_whitelist, accept_hostkey, update, ssh_opts, repo, bare, archive, refspec, executable, remote, recursive, separate_git_dir, verify_commit, depth, version, key_file

Manage I(git) checkouts of repositories to deploy files or software.

Git Config *arguments

Read and write git configuration

Arguments: repo, state, list_all, name, scope, value

The C(git_config) module changes git configuration by invoking 'git config'. This is needed if you don't want to use M(template) for the entire git config file (e.g. because you need to change just C(user.email) in /etc/.git/config). Solutions involving M(command) are cumbersome or don't work correctly in check mode.

Github Deploy Key *arguments

Manages deploy keys for GitHub repositories.

Arguments: read_only, username, force, name, state, repo, owner, token, key, otp, password

Adds or removes deploy keys for GitHub repositories. Supports authentication using username and password, username and password and 2-factor authentication code (OTP), OAuth2 token, or personal access token.

Github Issue *arguments

View GitHub issue.

Arguments: repo, organization, issue, action

View GitHub issue for a given repository and organization.

Github Key *arguments

Manage GitHub access keys.

Arguments: pubkey, token, force, name, state

Creates, removes, or updates GitHub access keys.

Github Release *arguments

Interact with GitHub Releases

Arguments: body, target, repo, token, tag, draft, user, action, prerelease, password, name

Fetch metadata about GitHub Releases

Github Webhook *arguments

Manage GitHub webhooks

Arguments: repository, insecure_ssl, url, secret, github_url, state, user, content_type, active, password, events, token

Create and delete GitHub webhooks

Github Webhook Info *arguments

Query information about GitHub webhooks

Arguments: github_url, token, password, user, repository

Query information about GitHub webhooks This module was called C(github_webhook_facts) before Ansible 2.9. The usage did not change.

Gitlab Deploy Key *arguments

Manages GitLab project deploy keys.

Arguments: project, state, key, title, can_push, api_token

Adds, updates and removes project deploy keys

Gitlab Group *arguments

Creates/updates/deletes GitLab Groups

Arguments: name, parent, login_user, api_token, server_url, visibility, state, login_password, path, description

When the group does not exist in GitLab, it will be created. When the group does exist and state=absent, the group will be deleted.

Gitlab Hook *arguments

Manages GitLab project hooks.

Arguments: hook_validate_certs, hook_url, job_events, tag_push_events, note_events, state, project, issues_events, token, push_events, merge_requests_events, api_token, pipeline_events, wiki_page_events

Adds, updates and removes project hook

Gitlab Project *arguments

Creates/updates/deletes GitLab Projects

Arguments: snippets_enabled, name, import_url, login_user, description, api_token, server_url, visibility, state, issues_enabled, login_password, group, path, wiki_enabled, merge_requests_enabled

When the project does not exist in GitLab, it will be created. When the project does exists and state=absent, the project will be deleted. When changes are made to the project, the project will be updated.

Gitlab Project Variable *arguments

Creates/updates/deletes GitLab Projects Variables

Arguments: project, purge, state, vars, api_token

When a project variable does not exist, it will be created. When a project variable does exist, its value will be updated when the values are different. Variables which are untouched in the playbook, but are not untouched in the GitLab project, they stay untouched (I(purge) is C(false)) or will be deleted (I(purge) is C(true)).

Gitlab Runner *arguments

Create, modify and delete GitLab Runners.

Arguments: locked, description, url, registration_token, run_untagged, access_level, state, api_token, active, tag_list, maximum_timeout

Register, update and delete runners with the GitLab API. All operations are performed using the GitLab API v4. For details, consult the full API documentation at U(https://docs.gitlab.com/ee/api/runners.html). A valid private API token is required for all operations. You can create as many tokens as you like using the GitLab web interface at U(https://$GITLAB_URL/profile/personal_access_tokens). A valid registration token is required for registering a new runner. To create shared runners, you need to ask your administrator to give you this token. It can be found at U(https://$GITLAB_URL/admin/runners/).

Gitlab User *arguments

Creates/updates/deletes GitLab Users

Arguments: username, sshkey_name, login_user, api_token, server_url, isadmin, external, login_password, password, group, name, sshkey_file, confirm, access_level, state, email

When the user does not exist in GitLab, it will be created. When the user does exists and state=absent, the user will be deleted. When changes are made to user, the user will be updated.

Gluster Heal Info *arguments

Gather information on self-heal or rebalance status

Arguments: name, status_filter

Gather facts about either self-heal or rebalance status. This module was called C(gluster_heal_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(gluster_heal_info) module no longer returns C(ansible_facts)!

Gluster Peer *arguments

Attach/Detach peers to/from the cluster

Arguments: state, force, nodes

Create or diminish a GlusterFS trusted storage pool. A set of nodes can be added into an existing trusted storage pool or a new storage pool can be formed. Or, nodes can be removed from an existing trusted storage pool.

Gluster Volume *arguments

Manage GlusterFS volumes

Arguments: arbiters, force, replicas, bricks, quota, stripes, cluster, host, start_on_create, redundancies, transport, name, disperses, state, directory, rebalance, options

Create, remove, start, stop and tune GlusterFS volumes

Grafana Dashboard *arguments

Manage Grafana dashboards

Arguments: url_password, uid, url, org_id, grafana_api_key, slug, state, url_username, path, message, client_key, validate_certs, client_cert, overwrite, use_proxy

Create, update, delete, export Grafana dashboards via API.

Grafana Datasource *arguments

Manage Grafana datasources

Arguments: tls_client_key, tsdb_version, trends, ds_type, aws_assume_role_arn, client_key, aws_secret_key, access, basic_auth_user, use_proxy, tls_skip_verify, grafana_url, with_credentials, tls_ca_cert, state, tls_client_cert, aws_auth_type, sslmode, client_cert, time_interval, aws_default_region, is_default, user, password, max_concurrent_shard_requests, url_password, aws_access_key, name, database, time_field, interval, org_id, tsdb_resolution, url, grafana_api_key, es_version, aws_custom_metrics_namespaces, url_username, basic_auth_password, validate_certs, aws_credentials_profile

Create/update/delete Grafana datasources via API.

Grafana Plugin *arguments

Manage Grafana plugins via grafana-cli

Arguments: state, grafana_repo, name, version, grafana_plugin_url, grafana_plugins_dir

Install and remove Grafana plugins. See U(https://grafana.com/docs/plugins/installation/) for upstream documentation.

Group *arguments

Add or remove groups

Arguments: state, non_unique, name, gid, local, system

Manage presence of groups on a host. For Windows targets, use the M(win_group) module instead.

Group By *arguments

Create Ansible groups based on facts

Arguments: parents, key

Use facts to create ad-hoc groups that can be used later in a playbook. This module is also supported for Windows targets.

Grove *arguments

Sends a notification to a grove.io channel

Arguments: service, url, icon_url, message, validate_certs, channel_token

The C(grove) module sends a message for a service to a Grove.io channel.

Gunicorn *arguments

Run gunicorn with various settings.

Arguments: venv, user, config, worker, app, chdir, pid

Starts gunicorn with the parameters specified. Common settings for gunicorn configuration are supported. For additional configuration use a config file See U(https://gunicorn-docs.readthedocs.io/en/latest/settings.html) for more options. It's recommended to always use the chdir option to avoid problems with the location of the app.

Haproxy *arguments

Enable, disable, and set weights for HAProxy backend servers using socket commands

Arguments: drain, socket, weight, wait_interval, state, backend, wait_retries, host, fail_on_not_found, shutdown_sessions, wait

Enable, disable, drain and set weights for HAProxy backend servers using socket commands.

Hcloud Datacenter Info *arguments

Gather info about the Hetzner Cloud datacenters.

Arguments: id, name

Gather info about your Hetzner Cloud datacenters. This module was called C(hcloud_datacenter_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_datacenter_facts). Note that the M(hcloud_datacenter_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_datacenter_info)!

Hcloud Floating Ip Info *arguments

Gather infos about the Hetzner Cloud Floating IPs.

Arguments: label_selector, id

Gather facts about your Hetzner Cloud Floating IPs. This module was called C(hcloud_floating_ip_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_floating_ip_facts). Note that the M(hcloud_floating_ip_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_floating_ip_info)!

Hcloud Image Info *arguments

Gather infos about your Hetzner Cloud images.

Arguments: label_selector, type, id, name

Gather infos about your Hetzner Cloud images. This module was called C(hcloud_location_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_location_facts). Note that the M(hcloud_image_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_image_info)!

Hcloud Location Info *arguments

Gather infos about your Hetzner Cloud locations.

Arguments: id, name

Gather infos about your Hetzner Cloud locations. This module was called C(hcloud_location_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_location_facts). Note that the M(hcloud_location_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_location_info)!

Hcloud Network *arguments

Create and manage cloud Networks on the Hetzner Cloud.

Arguments: state, labels, ip_range, name, id

Create, update and manage cloud Networks on the Hetzner Cloud. You need at least hcloud-python 1.3.0.

Hcloud Network Info *arguments

Gather info about your Hetzner Cloud networks.

Arguments: label_selector, id, name

Gather info about your Hetzner Cloud networks.

Hcloud Rdns *arguments

Create and manage reverse DNS entries on the Hetzner Cloud.

Arguments: dns_ptr, state, ip_address, server

Create, update and delete reverse DNS entries on the Hetzner Cloud.

Hcloud Route *arguments

Create and delete cloud routes on the Hetzner Cloud.

Arguments: state, destination, network, gateway

Create, update and delete cloud routes on the Hetzner Cloud.

Hcloud Server *arguments

Create and manage cloud servers on the Hetzner Cloud.

Arguments: datacenter, ssh_keys, server_type, rescue_mode, image, labels, user_data, name, state, location, volumes, backups, upgrade_disk, id, force_upgrade

Create, update and manage cloud servers on the Hetzner Cloud.

Hcloud Server Info *arguments

Gather infos about your Hetzner Cloud servers.

Arguments: label_selector, id, name

Gather infos about your Hetzner Cloud servers. This module was called C(hcloud_server_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_server_facts). Note that the M(hcloud_server_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_server_info)!

Hcloud Server Network *arguments

Manage the relationship between Hetzner Cloud Networks and servers

Arguments: ip, alias_ips, server, state, network

Create and delete the relationship Hetzner Cloud Networks and servers

Hcloud Server Type Info *arguments

Gather infos about the Hetzner Cloud server types.

Arguments: id, name

Gather infos about your Hetzner Cloud server types. This module was called C(hcloud_server_type_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_server_type_facts). Note that the M(hcloud_server_type_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_server_type_info)!

Hcloud Ssh Key *arguments

Create and manage ssh keys on the Hetzner Cloud.

Arguments: public_key, state, name, fingerprint, labels, id

Create, update and manage ssh keys on the Hetzner Cloud.

Hcloud Ssh Key Info *arguments

Gather infos about your Hetzner Cloud ssh_keys.

Arguments: label_selector, id, name, fingerprint

Gather facts about your Hetzner Cloud ssh_keys. This module was called C(hcloud_ssh_key_facts) before Ansible 2.9, returning C(ansible_facts) and C(hcloud_ssh_key_facts). Note that the M(hcloud_ssh_key_info) module no longer returns C(ansible_facts) and the value was renamed to C(hcloud_ssh_key_info)!

Hcloud Subnetwork *arguments

Manage cloud subnetworks on the Hetzner Cloud.

Arguments: state, ip_range, type, network, network_zone

Create, update and delete cloud subnetworks on the Hetzner Cloud.

Hcloud Volume *arguments

Create and manage block volumes on the Hetzner Cloud.

Arguments: name, format, automount, labels, server, state, location, id, size

Create, update and attach/detach block volumes on the Hetzner Cloud.

Hcloud Volume Info *arguments

Gather infos about your Hetzner Cloud volumes.

Arguments: label_selector, id, name

Gather infos about your Hetzner Cloud volumes.

Helm *arguments

Manages Kubernetes packages with the Helm package manager

Arguments: disable_hooks, name, namespace, chart, state, values, host, port

Install, upgrade, delete and list packages with the Helm package manager.

Heroku Collaborator *arguments

Add or delete app collaborators on Heroku

Arguments: suppress_invitation, api_key, apps, user, state

Manages collaborators for Heroku apps. If set to C(present) and heroku user is already collaborator, then do nothing. If set to C(present) and heroku user is not collaborator, then add user to app. If set to C(absent) and heroku user is collaborator, then delete user from app.

Hetzner Failover Ip *arguments

Manage Hetzner's failover IPs

Arguments: value, state, failover_ip, timeout

Manage Hetzner's failover IPs.

Hetzner Failover Ip Info *arguments

Retrieve information on Hetzner's failover IPs

Arguments: failover_ip

Retrieve information on Hetzner's failover IPs.

Hg *arguments

Manages Mercurial (hg) repositories

Arguments: repo, executable, force, dest, clone, update, purge, revision

Manages Mercurial (hg) repositories. Supports SSH, HTTP/S and local address.

Hipchat *arguments

Send a message to Hipchat.

Arguments: from, room, color, msg_format, token, api, notify, msg, validate_certs

Send a message to a Hipchat room, with options to control the formatting.

Homebrew *arguments

Package manager for Homebrew

Arguments: install_options, state, name, update_homebrew, path, upgrade_all

Manages Homebrew packages

Homebrew Cask *arguments

Install/uninstall homebrew casks.

Arguments: install_options, upgrade, sudo_password, name, update_homebrew, upgrade_all, accept_external_apps, greedy, state, path

Manages Homebrew casks.

Homebrew Tap *arguments

Tap a Homebrew repository.

Arguments: url, state, name

Tap external Homebrew repositories.

Honeybadger Deployment *arguments

Notify Honeybadger.io about app deployments

Arguments: repo, environment, token, user, url, validate_certs, revision

Notify Honeybadger.io about app deployments (see http://docs.honeybadger.io/article/188-deployment-tracking)

Hostname *arguments

Manage hostname

Arguments: use, name

Set system's hostname, supports most OSs/Distributions, including those using systemd. Note, this module does NOT modify C(/etc/hosts). You need to modify it yourself using other modules like template or replace. Windows, HP-UX and AIX are not currently supported.

Hpilo Boot *arguments

Boot system using specific media through HP iLO interface

Arguments: force, media, image, ssl_version, host, state, login, password

This module boots a system through its HP iLO interface. The boot media can be one of: cdrom, floppy, hdd, network or usb. This module requires the hpilo python module.

Hpilo Info *arguments

Gather information through an HP iLO interface

Arguments: host, password, ssl_version, login

This module gathers information on a specific system using its HP iLO interface. These information includes hardware and network related information useful for provisioning (e.g. macaddress, uuid). This module requires the C(hpilo) python module. This module was called C(hpilo_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(hpilo_info) module no longer returns C(ansible_facts)!

Hponcfg *arguments

Configure HP iLO interface using hponcfg

Arguments: path, executable, minfw, verbose

This modules configures the HP iLO interface using hponcfg.

Htpasswd *arguments

manage user files for basic authentication

Arguments: state, name, path, create, password, crypt_scheme

Add and remove username/password entries in a password file using htpasswd. This is used by web servers such as Apache and Nginx for basic authentication.

Hwc Network Vpc *arguments

Creates a Huawei Cloud VPC

Arguments: timeouts, state, cidr, name

Represents an vpc resource.

Hwc Smn Topic *arguments

Creates a resource of SMNTopic in Huaweicloud Cloud

Arguments: state, display_name, name

Represents a SMN notification topic resource.

Iam *arguments

Manage IAM users, groups, roles and keys

Arguments: new_name, update_password, new_path, name, access_key_state, key_count, iam_type, state, access_key_ids, groups, trust_policy, path, password, trust_policy_filepath

Allows for the management of IAM users, user API keys, groups, roles.

Iam Cert *arguments

Manage server certificates for use on ELBs and CloudFront

Arguments: new_name, dup_ok, new_path, name, state, cert, key, path, cert_chain

Allows for the management of server certificates

Iam Group *arguments

Manage AWS IAM groups

Arguments: state, name, purge_policy, purge_users, managed_policy, users

Manage AWS IAM groups

Iam Managed Policy *arguments

Manage User Managed IAM policies

Arguments: state, policy_description, make_default, policy, fail_on_delete, only_version, policy_name

Allows creating and removing managed IAM policies

Iam Mfa Device Info *arguments

List the MFA (Multi-Factor Authentication) devices registered for a user

Arguments: user_name

List the MFA (Multi-Factor Authentication) devices registered for a user This module was called C(iam_mfa_device_facts) before Ansible 2.9. The usage did not change.

Iam Password Policy *arguments

Update an IAM Password Policy

Arguments: require_lowercase, allow_pw_change, pw_reuse_prevent, pw_max_age, state, min_pw_length, require_symbols, pw_expire, require_numbers, require_uppercase

Module updates an IAM Password Policy on a given AWS account

Iam Policy *arguments

Manage IAM policies for users, groups, and roles

Arguments: policy_document, state, policy_json, skip_duplicates, iam_name, iam_type, policy_name

Allows uploading or removing IAM policies for IAM users, groups or roles.

Iam Role *arguments

Manage AWS IAM roles

Arguments: name, managed_policy, purge_policies, assume_role_policy_document, state, create_instance_profile, path, boundary, description

Manage AWS IAM roles

Iam Role Info *arguments

Gather information on IAM roles

Arguments: name, path_prefix

Gathers information about IAM roles This module was called C(iam_role_facts) before Ansible 2.9. The usage did not change.

Iam Server Certificate Info *arguments

Retrieve the information of a server certificate

Arguments: name

Retrieve the attributes of a server certificate This module was called C(iam_server_certificate_facts) before Ansible 2.9. The usage did not change.

Iam User *arguments

Manage AWS IAM users

Arguments: purge_policy, state, managed_policy, name

Manage AWS IAM users

Iap Start Workflow *arguments

Start a workflow in the Itential Automation Platform

Arguments: description, iap_fqdn, workflow_name, token_key, iap_port, https, validate_certs, variables

This will start a specified workflow in the Itential Automation Platform with given arguments.

Iap Token *arguments

Get token for the Itential Automation Platform

Arguments: username, iap_port, https, iap_fqdn, password, validate_certs

Checks the connection to IAP and retrieves a login token.

Ibm Sa Domain *arguments

Manages domains on IBM Spectrum Accelerate Family storage systems

Arguments: max_cgs, domain, ldap_id, soft_capacity, state, hard_capacity, max_volumes, max_mirrors, max_pools, max_dms, perf_class, size

This module can be used to add domains to or removes them from IBM Spectrum Accelerate Family storage systems.

Ibm Sa Host *arguments

Adds hosts to or removes them from IBM Spectrum Accelerate Family storage systems.

Arguments: iscsi_chap_name, domain, iscsi_chap_secret, cluster, host, state

This module adds hosts to or removes them from IBM Spectrum Accelerate Family storage systems.

Ibm Sa Host Ports *arguments

Add host ports on IBM Spectrum Accelerate Family storage systems.

Arguments: iscsi_name, fcaddress, host, num_of_visible_targets, state

This module adds ports to or removes them from the hosts on IBM Spectrum Accelerate Family storage systems.

Ibm Sa Pool *arguments

Handles pools on IBM Spectrum Accelerate Family storage systems.

Arguments: domain, pool, size, state, perf_class, snapshot_size

This module creates or deletes pools to be used on IBM Spectrum Accelerate Family storage systems

Ibm Sa Vol *arguments

Handle volumes on IBM Spectrum Accelerate Family storage systems.

Arguments: vol, state, pool, size

This module creates or deletes volumes to be used on IBM Spectrum Accelerate Family storage systems.

Ibm Sa Vol Map *arguments

Handles volume mapping on IBM Spectrum Accelerate Family storage systems.

Arguments: cluster, host, override, vol, state, lun

This module maps volumes to or unmaps them from the hosts on IBM Spectrum Accelerate Family storage systems.

Icinga2 Feature *arguments

Manage Icinga2 feature

Arguments: state, name

This module can be used to enable or disable an Icinga2 feature.

Icinga2 Host *arguments

Manage a host in Icinga2

Arguments: url_username, ip, variables, force_basic_auth, name, url_password, display_name, use_proxy, zone, url, check_command, state, template, client_key, validate_certs, client_cert

Add or remove a host to Icinga2 through the API. See U(https://www.icinga.com/docs/icinga2/latest/doc/12-icinga2-api/)

Icx Banner *arguments

Manage multiline banners on Ruckus ICX 7000 series switches

Arguments: text, state, banner, check_running_config, enterkey

This will configure both login and motd banners on remote ruckus ICX 7000 series switches. It allows playbooks to add or remove banner text from the active running configuration.

Icx Command *arguments

Run arbitrary commands on remote Ruckus ICX 7000 series switches

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an ICX node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Icx Config *arguments

Manage configuration sections of Ruckus ICX 7000 series switches

Arguments: multiline_delimiter, src, save_when, after, lines, intended_config, diff_against, parents, defaults, before, running_config, replace, backup, match, diff_ignore_lines

Ruckus ICX configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with ICX configuration sections in a deterministic way.

Icx Copy *arguments

Transfer files from or to remote Ruckus ICX 7000 series switches

Arguments: public_key, remote_user, protocol, remote_server, remote_port, remote_filename, upload, remote_pass, download

This module transfers files from or to remote devices running ICX.

Icx Facts *arguments

Collect facts from remote Ruckus ICX 7000 series switches

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running ICX. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Icx Interface *arguments

Manage Interface on Ruckus ICX 7000 series switches

Arguments: neighbors, rx_rate, name, power, enabled, delay, state, stp, aggregate, speed, check_running_config, tx_rate, description

This module provides declarative management of Interfaces on ruckus icx devices.

Icx L3 Interface *arguments

Manage Layer-3 interfaces on Ruckus ICX 7000 series switches

Arguments: name, replace, state, mode, ipv6, aggregate, secondary, check_running_config, ipv4

This module provides declarative management of Layer-3 interfaces on ICX network devices.

Icx Linkagg *arguments

Manage link aggregation groups on Ruckus ICX 7000 series switches

Arguments: group, name, purge, state, mode, members, aggregate, check_running_config

This module provides declarative management of link aggregation groups on Ruckus ICX network devices.

Icx Lldp *arguments

Manage LLDP configuration on Ruckus ICX 7000 series switches

Arguments: interfaces, check_running_config, state

This module provides declarative management of LLDP service on ICX network devices.

Icx Logging *arguments

Manage logging on Ruckus ICX 7000 series switches

Arguments: name, level, dest, facility, udp_port, state, aggregate, check_running_config

This module provides declarative management of logging on Ruckus ICX 7000 series switches.

Icx Ping *arguments

Tests reachability using ping from Ruckus ICX 7000 series switches

Arguments: count, dest, source, state, vrf, timeout, ttl, size

Tests reachability using ping from switch to a remote destination.

Icx Static Route *arguments

Manage static IP routes on Ruckus ICX 7000 series switches

Arguments: mask, prefix, admin_distance, purge, state, next_hop, aggregate, check_running_config

This module provides declarative management of static IP routes on Ruckus ICX network devices.

Icx System *arguments

Manage the system attributes on Ruckus ICX 7000 series switches

Arguments: aaa_servers, state, name_servers, domain_search, hostname, domain_name, check_running_config

This module provides declarative management of node system attributes on Ruckus ICX 7000 series switches. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Icx User *arguments

Manage the user accounts on Ruckus ICX 7000 series switches.

Arguments: update_password, configured_password, aggregate, name, access_time, purge, privilege, state, nopassword, check_running_config

This module creates or updates user account on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Icx Vlan *arguments

Manage VLANs on Ruckus ICX 7000 series switches

Arguments: delay, tagged, ip_arp_inspection, name, interfaces, associated_tagged, purge, associated_interfaces, state, stp, ip_dhcp_snooping, aggregate, check_running_config, vlan_id

This module provides declarative management of VLANs on ICX network devices.

Idrac Firmware *arguments

Firmware update from a repository on a network share (CIFS, NFS).

Arguments: idrac_user, share_name, idrac_port, reboot, share_user, catalog_file_name, share_password, share_mnt, idrac_password, idrac_ip, job_wait

Update the Firmware by connecting to a network share (either CIFS or NFS) that contains a catalog of available updates. Network share should contain a valid repository of Update Packages (DUPs) and a catalog file describing the DUPs. All applicable updates contained in the repository are applied to the system. This feature is available only with iDRAC Enterprise License.

Idrac Redfish Command *arguments

Manages Out-Of-Band controllers using iDRAC OEM Redfish APIs

Arguments: category, username, command, timeout, baseuri, password

Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action. For use with Dell iDRAC operations that require Redfish OEM extensions

Idrac Redfish Config *arguments

Manages servers through iDRAC using Dell Redfish APIs

Arguments: category, username, manager_attribute_value, baseuri, command, timeout, password, manager_attribute_name

For use with Dell iDRAC operations that require Redfish OEM extensions Builds Redfish URIs locally and sends them to remote iDRAC controllers to set or update a configuration attribute.

Idrac Redfish Info *arguments

Manages servers through iDRAC using Dell Redfish APIs

Arguments: category, username, command, timeout, baseuri, password

Builds Redfish URIs locally and sends them to remote iDRAC controllers to get information back. For use with Dell iDRAC operations that require Redfish OEM extensions This module was called C(idrac_redfish_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(idrac_redfish_info) module no longer returns C(ansible_facts)!

Idrac Server Config Profile *arguments

Export or Import iDRAC Server Configuration Profile (SCP).

Arguments: end_host_power_state, idrac_user, job_wait, scp_file, export_use, share_name, idrac_port, scp_components, shutdown_type, command, export_format, share_password, idrac_password, idrac_ip, share_user

Export the Server Configuration Profile (SCP) from the iDRAC or Import from a network share or a local file.

Ig Config *arguments

Manage the configuration database on an Ingate SBC.

Arguments: get, modify, no_response, store_download, rowid, path, download, table, return_rowid, revert, factory, filename, add, store, columns, delete

Manage the configuration database on an Ingate SBC.

Ig Unit Information *arguments

Get unit information from an Ingate SBC.

Arguments:

Get unit information from an Ingate SBC.

Imc Rest *arguments

Manage Cisco IMC hardware through its REST API

Arguments: username, protocol, hostname, content, timeout, path, password, validate_certs

Provides direct access to the Cisco IMC REST API. Perform any configuration changes and actions that the Cisco IMC supports. More information about the IMC REST API is available from U(http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html)

Imgadm *arguments

Manage SmartOS images

Arguments: source, state, force, uuid, type, pool

Manage SmartOS virtual machine images through imgadm(1M)

Import Playbook *arguments

Import a playbook

Arguments: free-form

Includes a file with a list of plays to be executed. Files with a list of plays can only be included at the top level. You cannot use this action inside a play.

Import Role *arguments

Import a role into a play

Arguments: allow_duplicates, tasks_from, vars_from, name, handlers_from, defaults_from

Much like the C(roles:) keyword, this task loads a role, but it allows you to control it when the role tasks run in between other tasks of the play. Most keywords, loops and conditionals will only be applied to the imported tasks, not to this statement itself. If you want the opposite behavior, use M(include_role) instead.

Import Tasks *arguments

Import a task list

Arguments: free-form

Imports a list of tasks to be added to the current playbook for subsequent execution.

Include *arguments

Include a play or task list

Arguments: free-form

Includes a file with a list of plays or tasks to be executed in the current playbook. Files with a list of plays can only be included at the top level. Lists of tasks can only be included where tasks normally run (in play). Before Ansible 2.0, all includes were 'static' and were executed when the play was compiled. Static includes are not subject to most directives. For example, loops or conditionals are applied instead to each inherited task. Since Ansible 2.0, task includes are dynamic and behave more like real tasks. This means they can be looped, skipped and use variables from any source. Ansible tries to auto detect this, but you can use the C(static) directive (which was added in Ansible 2.1) to bypass autodetection. This module is also supported for Windows targets.

Include Role *arguments

Load and execute a role

Arguments: name, allow_duplicates, tasks_from, vars_from, apply, handlers_from, defaults_from, public

Dynamically loads and executes a specified role as a task. May be used only where Ansible tasks are allowed - inside C(pre_tasks), C(tasks), or C(post_tasks) playbook objects, or as a task inside a role. Task-level keywords, loops, and conditionals apply only to the C(include_role) statement itself. To apply keywords to the tasks within the role, pass them using the C(apply) option or use M(import_role) instead. Ignores some keywords, like C(until) and C(retries). This module is also supported for Windows targets.

Include Tasks *arguments

Dynamically include a task list

Arguments: free-form, apply, file

Includes a file with a list of tasks to be executed in the current playbook.

Include Vars *arguments

Load variables from files, dynamically within a task

Arguments: ignore_files, ignore_unknown_extensions, free-form, files_matching, depth, extensions, file, dir, name

Loads YAML/JSON variables dynamically from a file or directory, recursively, during task runtime. If loading a directory, the files are sorted alphabetically before being loaded. This module is also supported for Windows targets. To assign included variables to a different host than C(inventory_hostname), use C(delegate_to) and set C(delegate_facts=yes).

Infini Export *arguments

Create, Delete or Modify NFS Exports on Infinibox

Arguments: inner_path, state, client_list, name, filesystem

This module creates, deletes or modifies NFS exports on Infinibox.

Infini Export Client *arguments

Create, Delete or Modify NFS Client(s) for existing exports on Infinibox

Arguments: state, access_mode, export, no_root_squash, client

This module creates, deletes or modifys NFS client(s) for existing exports on Infinibox.

Infini Fs *arguments

Create, Delete or Modify filesystems on Infinibox

Arguments: state, name, pool, size

This module creates, deletes or modifies filesystems on Infinibox.

Infini Host *arguments

Create, Delete and Modify Hosts on Infinibox

Arguments: volume, state, name, wwns

This module creates, deletes or modifies hosts on Infinibox.

Infini Pool *arguments

Create, Delete and Modify Pools on Infinibox

Arguments: vsize, state, ssd_cache, name, size

This module to creates, deletes or modifies pools on Infinibox.

Infini Vol *arguments

Create, Delete or Modify volumes on Infinibox

Arguments: state, name, pool, size

This module creates, deletes or modifies volume on Infinibox.

Infinity *arguments

Manage Infinity IPAM using Rest API

Arguments: username, network_size, network_location, network_family, network_id, ip_address, network_address, server_ip, action, password, network_name, network_type

Manage Infinity IPAM using REST API.

Influxdb Database *arguments

Manage InfluxDB databases

Arguments: database_name, state

Manage InfluxDB databases.

Influxdb Query *arguments

Query data points from InfluxDB

Arguments: query, database_name

Query data points from InfluxDB.

Influxdb Retention Policy *arguments

Manage InfluxDB retention policies

Arguments: duration, replication, database_name, policy_name, default

Manage InfluxDB retention policies.

Influxdb User *arguments

Manage InfluxDB users

Arguments: admin, user_password, grants, user_name, state

Manage InfluxDB users.

Influxdb Write *arguments

Write data points into InfluxDB

Arguments: data_points, database_name

Write data points into InfluxDB.

Ini File *arguments

Tweak settings in INI files

Arguments: option, section, no_extra_spaces, value, allow_no_value, state, path, backup, create

Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, M(template) or M(assemble). Adds missing sections if they don't exist. Before Ansible 2.0, comments are discarded when the source file is read, and therefore will not show up in the destination file. Since Ansible 2.3, this module adds missing ending newlines to files to keep in line with the POSIX standard, even when no other modifications need to be applied.

Installp *arguments

Manage packages on AIX

Arguments: repository_path, accept_license, name, state

Manage packages using 'installp' on AIX

Interfaces File *arguments

Tweak settings in /etc/network/interfaces files

Arguments: state, iface, address_family, dest, backup, value, option

Manage (add, remove, change) individual interface options in an interfaces-style file without having to manage the file as a whole with, say, M(template) or M(assemble). Interface has to be presented in a file. Read information about interfaces from interfaces-styled files

Intersight Info *arguments

Gather information about Intersight

Arguments: server_names

Gathers information about servers in L(Cisco Intersight,https://intersight.com). This module was called C(intersight_facts) before Ansible 2.9. The usage did not change.

Intersight Rest Api *arguments

REST API configuration for Cisco Intersight

Arguments: update_method, query_params, state, resource_path, api_body

Direct REST API configuration for Cisco Intersight. All REST API resources and properties must be specified. For more information see L(Cisco Intersight,https://intersight.com/apidocs).

Ios Banner *arguments

Manage multiline banners on Cisco IOS devices

Arguments: text, state, banner

This will configure both login and motd banners on remote devices running Cisco IOS. It allows playbooks to add or remote banner text from the active running configuration.

Ios Bgp *arguments

Configure global BGP protocol settings on Cisco IOS.

Arguments: operation, config

This module provides configuration management of global BGP parameters on devices running Cisco IOS

Ios Command *arguments

Run commands on remote devices running Cisco IOS

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an ios node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(ios_config) to configure IOS devices.

Ios Config *arguments

Manage Cisco IOS configuration sections

Arguments: multiline_delimiter, backup_options, after, diff_against, replace, running_config, diff_ignore_lines, src, lines, intended_config, parents, defaults, before, save_when, backup, match

Cisco IOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS configuration sections in a deterministic way.

Ios Facts *arguments

Collect facts from remote devices running Cisco IOS

Arguments: gather_subset, gather_network_resources

Collects a base set of device facts from a remote device that is running IOS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Ios Interfaces *arguments

Manages interface attributes of Cisco IOS network devices

Arguments: state, config

This module manages the interface attributes of Cisco IOS network devices.

Ios L2 Interfaces *arguments

Manage Layer-2 interface on Cisco IOS devices.

Arguments: state, config

This module provides declarative management of Layer-2 interface on Cisco IOS devices.

Ios L3 Interfaces *arguments

Manage Layer-3 interface on Cisco IOS devices.

Arguments: state, config

This module provides declarative management of Layer-3 interface on Cisco IOS devices.

Ios Lacp *arguments

Manage Global Link Aggregation Control Protocol (LACP) on Cisco IOS devices.

Arguments: state, config

This module provides declarative management of Global LACP on Cisco IOS network devices.

Ios Lacp Interfaces *arguments

Manage Link Aggregation Control Protocol (LACP) on Cisco IOS devices interface.

Arguments: state, config

This module provides declarative management of LACP on Cisco IOS network devices lacp_interfaces.

Ios Lag Interfaces *arguments

Manage Link Aggregation on Cisco IOS devices.

Arguments: state, config

This module manages properties of Link Aggregation Group on Cisco IOS devices.

Ios Linkagg *arguments

Manage link aggregation groups on Cisco IOS network devices

Arguments: purge, state, group, mode, members, aggregate

This module provides declarative management of link aggregation groups on Cisco IOS network devices.

Ios Lldp *arguments

Manage LLDP configuration on Cisco IOS network devices.

Arguments: state

This module provides declarative management of LLDP service on Cisco IOS network devices.

Ios Lldp Global *arguments

Configure and manage Link Layer Discovery Protocol(LLDP) attributes on IOS platforms.

Arguments: state, config

This module configures and manages the Link Layer Discovery Protocol(LLDP) attributes on IOS platforms.

Ios Lldp Interfaces *arguments

Manage link layer discovery protocol (LLDP) attributes of interfaces on Cisco IOS devices.

Arguments: state, config

This module manages link layer discovery protocol (LLDP) attributes of interfaces on Cisco IOS devices.

Ios Logging *arguments

Manage logging on network devices

Arguments: aggregate, state, name, level, dest, facility, size

This module provides declarative management of logging on Cisco Ios devices.

Ios Ntp *arguments

Manages core NTP configuration.

Arguments: logging, auth_key, auth, source_int, state, key_id, acl, server

Manages core NTP configuration.

Ios Ping *arguments

Tests reachability using ping from Cisco IOS network devices

Arguments: count, dest, state, vrf, source

Tests reachability using ping from switch to a remote destination. For a general purpose network module, see the M(net_ping) module. For Windows targets, use the M(win_ping) module instead. For targets running Python, use the M(ping) module instead.

Ios Static Route *arguments

Manage static IP routes on Cisco IOS network devices

Arguments: name, track, mask, prefix, admin_distance, interface, state, next_hop, vrf, aggregate, tag

This module provides declarative management of static IP routes on Cisco IOS network devices.

Ios System *arguments

Manage the system attributes on Cisco IOS devices

Arguments: state, lookup_source, name_servers, domain_search, hostname, domain_name, lookup_enabled

This module provides declarative management of node system attributes on Cisco IOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Ios User *arguments

Manage the aggregate of local users on Cisco IOS device

Arguments: update_password, configured_password, aggregate, name, view, hashed_password, purge, privilege, state, nopassword, password_type, sshkey

This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Ios Vlans *arguments

Manage VLANs on Cisco IOS devices.

Arguments: state, config

This module provides declarative management of VLANs on Cisco IOS network devices.

Ios Vrf *arguments

Manage the collection of VRF definitions on Cisco IOS devices

Arguments: purge, route_import_ipv4, description, route_import_ipv6, route_export_ipv4, route_both_ipv4, interfaces, associated_interfaces, route_export_ipv6, rd, route_import, name, delay, route_export, state, vrfs, route_both, route_both_ipv6

This module provides declarative management of VRF definitions on Cisco IOS devices. It allows playbooks to manage individual or the entire VRF collection. It also supports purging VRF definitions from the configuration that are not explicitly defined.

Iosxr Banner *arguments

Manage multiline banners on Cisco IOS XR devices

Arguments: text, state, banner

This module will configure both exec and motd banners on remote device running Cisco IOS XR. It allows playbooks to add or remove banner text from the running configuration.

Iosxr Bgp *arguments

Configure global BGP protocol settings on Cisco IOS-XR

Arguments: operation, config

This module provides configuration management of global BGP parameters on devices running Cisco IOS-XR

Iosxr Command *arguments

Run commands on remote devices running Cisco IOS XR

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an IOS XR node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(iosxr_config) to configure iosxr devices.

Iosxr Config *arguments

Manage Cisco IOS XR configuration sections

Arguments: comment, src, backup_options, force, exclusive, admin, config, after, lines, replace, parents, label, backup, match, before

Cisco IOS XR configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS XR configuration sections in a deterministic way.

Iosxr Facts *arguments

Get facts about iosxr devices.

Arguments: gather_subset, gather_network_resources

Collects facts from network devices running the iosxr operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Iosxr Interfaces *arguments

Manage interface attributes on Cisco IOS-XR network devices

Arguments: state, config

This module manages the interface attributes on Cisco IOS-XR network devices.

Iosxr L2 Interfaces *arguments

Manage Layer-2 interface on Cisco IOS-XR devices

Arguments: state, config

This module manages the Layer-2 interface attributes on Cisco IOS-XR devices.

Iosxr L3 Interfaces *arguments

Manage Layer-3 interface on Cisco IOS-XR devices.

Arguments: state, config

This module provides declarative management of Layer-3 interface on Cisco IOS-XR devices.

Iosxr Lacp *arguments

Manage Global Link Aggregation Control Protocol (LACP) on IOS-XR devices.

Arguments: state, config

This module manages Global Link Aggregation Control Protocol (LACP) on IOS-XR devices.

Iosxr Lacp Interfaces *arguments

Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on IOS-XR devices.

Arguments: state, config

This module manages Link Aggregation Control Protocol (LACP) attributes of interfaces on IOS-XR devices.

Iosxr Lag Interfaces *arguments

Manages attributes of LAG/Ether-Bundle interfaces on IOS-XR devices.

Arguments: state, config

This module manages the attributes of LAG/Ether-Bundle interfaces on IOS-XR devices.

Iosxr Lldp Global *arguments

Manage Global Link Layer Discovery Protocol (LLDP) settings on IOS-XR devices.

Arguments: state, config

This module manages Global Link Layer Discovery Protocol (LLDP) settings on IOS-XR devices.

Iosxr Lldp Interfaces *arguments

Manage Link Layer Discovery Protocol (LLDP) attributes of interfaces on IOS-XR devices.

Arguments: state, config

This module manages Link Layer Discovery Protocol (LLDP) attributes of interfaces on IOS-XR devices.

Iosxr Logging *arguments

Configuration management of system logging services on network devices

Arguments: name, facility, dest, level, hostnameprefix, state, vrf, aggregate, size

This module provides declarative management configuration of system logging (syslog) on Cisco IOS XR devices.

Iosxr Netconf *arguments

Configures NetConf sub-system service on Cisco IOS-XR devices

Arguments: state, netconf_vrf, netconf_port

This module provides an abstraction that enables and configures the netconf system service running on Cisco IOS-XR Software. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242.

Iosxr System *arguments

Manage the system attributes on Cisco IOS XR devices

Arguments: lookup_source, domain_search, hostname, domain_name, state, vrf, name_servers, lookup_enabled

This module provides declarative management of node system attributes on Cisco IOS XR devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Iosxr User *arguments

Manage the aggregate of local users on Cisco IOS XR device

Arguments: public_key, update_password, configured_password, group, name, admin, purge, state, public_key_contents, groups, aggregate

This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Ip Netns *arguments

Manage network namespaces

Arguments: state, name

Create or delete network namespaces using the ip command.

Ipa Config *arguments

Manage Global FreeIPA Configuration Settings

Arguments: ipadefaultloginshell, ipadefaultemaildomain

Modify global configuration settings of a FreeIPA Server.

Ipa Dnsrecord *arguments

Manage FreeIPA DNS records

Arguments: record_type, state, record_name, zone_name, record_ttl, record_value

Add, modify and delete an IPA DNS Record using IPA API.

Ipa Dnszone *arguments

Manage FreeIPA DNS Zones

Arguments: zone_name, state, dynamicupdate

Add and delete an IPA DNS Zones using IPA API

Ipa Group *arguments

Manage FreeIPA group

Arguments: group, cn, description, gidnumber, state, user, nonposix, external

Add, modify and delete group within IPA server

Ipa Hbacrule *arguments

Manage FreeIPA HBAC rule

Arguments: servicecategory, sourcehostcategory, cn, service, description, hostcategory, hostgroup, usercategory, state, user, usergroup, host, servicegroup, sourcehostgroup, sourcehost

Add, modify or delete an IPA HBAC rule using IPA API.

Ipa Host *arguments

Manage FreeIPA host

Arguments: force, description, ns_os_version, fqdn, state, random_password, ns_host_location, mac_address, user_certificate, ip_address, ns_hardware_platform, update_dns

Add, modify and delete an IPA host using IPA API

Ipa Hostgroup *arguments

Manage FreeIPA host-group

Arguments: host, description, state, hostgroup, cn

Add, modify and delete an IPA host-group using IPA API

Ipa Role *arguments

Manage FreeIPA role

Arguments: group, cn, service, host, hostgroup, state, user, privilege, description

Add, modify and delete a role within FreeIPA server using FreeIPA API

Ipa Service *arguments

Manage FreeIPA service

Arguments: hosts, state, force, krbcanonicalname

Add and delete an IPA service using IPA API

Ipa Subca *arguments

Manage FreeIPA Lightweight Sub Certificate Authorities.

Arguments: subca_desc, subca_name, state, subca_subject

Add, modify, enable, disable and delete an IPA Lightweight Sub Certificate Authorities using IPA API.

Ipa Sudocmd *arguments

Manage FreeIPA sudo command

Arguments: state, description, sudocmd

Add, modify or delete sudo command within FreeIPA server using FreeIPA API.

Ipa Sudocmdgroup *arguments

Manage FreeIPA sudo command group

Arguments: state, cn, sudocmd, description

Add, modify or delete sudo command group within IPA server using IPA API.

Ipa Sudorule *arguments

Manage FreeIPA sudo rule

Arguments: cn, runasgroupcategory, runasusercategory, cmd, host, hostgroup, usercategory, hostcategory, state, sudoopt, user, usergroup, cmdcategory, description

Add, modify or delete sudo rule within IPA server using IPA API.

Ipa User *arguments

Manage FreeIPA users

Arguments: telephonenumber, sshpubkey, update_password, givenname, displayname, uid, krbpasswordexpiration, title, loginshell, uidnumber, state, gidnumber, sn, mail, password

Add, modify and delete user within IPA server

Ipa Vault *arguments

Manage FreeIPA vaults

Arguments: username, cn, service, ipavaultsalt, replace, state, ipavaultpublickey, ipavaulttype, validate_certs, description

Add, modify and delete vaults and secret vaults. KRA service should be enabled to use this module.

Ipadm Addr *arguments

Manage IP addresses on an interface on Solaris/illumos systems

Arguments: addrtype, state, temporary, address, addrobj, wait

Create/delete static/dynamic IP addresses on network interfaces on Solaris/illumos systems. Up/down static/dynamic IP addresses on network interfaces on Solaris/illumos systems. Manage IPv6 link-local addresses on network interfaces on Solaris/illumos systems.

Ipadm Addrprop *arguments

Manage IP address properties on Solaris/illumos systems.

Arguments: state, property, temporary, value, addrobj

Modify IP address properties on Solaris/illumos systems.

Ipadm If *arguments

Manage IP interfaces on Solaris/illumos systems.

Arguments: state, temporary, name

Create, delete, enable or disable IP interfaces on Solaris/illumos systems.

Ipadm Ifprop *arguments

Manage IP interface properties on Solaris/illumos systems.

Arguments: state, temporary, interface, protocol, property, value

Modify IP interface properties on Solaris/illumos systems.

Ipadm Prop *arguments

Manage protocol properties on Solaris/illumos systems.

Arguments: protocol, state, property, temporary, value

Modify protocol properties on Solaris/illumos systems.

Ipify Facts *arguments

Retrieve the public IP of your internet gateway

Arguments: validate_certs, api_url, timeout

If behind NAT and need to know the public IP of your internet gateway.

Ipinfoio Facts *arguments

Retrieve IP geolocation facts of a host's IP address

Arguments: http_agent, timeout

Gather IP geolocation facts of a host's IP address using ipinfo.io API

Ipmi Boot *arguments

Management of order of boot devices

Arguments: bootdev, name, persistent, uefiboot, state, user, password, port

Use this module to manage order of boot devices

Ipmi Power *arguments

Power management for machine

Arguments: state, name, timeout, password, port, user

Use this module for power management

Iptables *arguments

Modify iptables rules

Arguments: tcp_flags, comment, log_prefix, protocol, chain, in_interface, out_interface, limit_burst, ctstate, jump, to_ports, flush, table, icmp_type, to_destination, gateway, uid_owner, set_dscp_mark_class, log_level, src_range, destination, state, source, set_dscp_mark, policy, set_counters, match, dst_range, goto, fragment, to_source, syn, gid_owner, source_port, rule_num, destination_port, reject_with, limit, action, ip_version

C(iptables) is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux kernel. This module does not handle the saving and/or loading of rules, but rather only manipulates the current rules that are present in memory. This is the same as the behaviour of the C(iptables) and C(ip6tables) command which this module uses internally.

Irc *arguments

Send a message to an IRC channel

Arguments: style, key, passwd, color, server, topic, nick, part, nick_to, timeout, msg, use_ssl, port, channel

Send a message to an IRC channel. This is a very simplistic implementation.

Ironware Command *arguments

Run arbitrary commands on Extreme IronWare devices

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to a Extreme Ironware node and returns the results read from the device. This module includes a I(wait_for) argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Ironware Config *arguments

Manage configuration sections on Extreme Ironware devices

Arguments: src, backup_options, backup, after, lines, update, replace, parents, commit, save_when, config, match, before

Extreme Ironware configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with Ironware configuration sections in a deterministic way.

Ironware Facts *arguments

Collect facts from devices running Extreme Ironware

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running Ironware. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Iso Extract *arguments

Extract files from an ISO image

Arguments: dest, files, image, force, executable

This module has two possible ways of operation. If 7zip is installed on the system, this module extracts files from an ISO into a temporary directory and copies files to a given destination, if needed. If the user has mount-capabilities (CAP_SYS_ADMIN on Linux) this module mounts the ISO image to a temporary location, and copies files to a given destination, if needed.

Jabber *arguments

Send a message to jabber user or chat room

Arguments: to, host, user, encoding, msg, password, port

Send a message to jabber

Java Cert *arguments

Uses keytool to import/remove key from java keystore (cacerts)

Arguments: keystore_create, cert_alias, executable, pkcs12_password, cert_port, pkcs12_alias, keystore_type, state, keystore_pass, pkcs12_path, cert_url, cert_path, keystore_path

This is a wrapper module around keytool, which can be used to import/remove certificates from a given java keystore.

Java Keystore *arguments

Create or delete a Java keystore in JKS format.

Arguments: private_key, group, name, certificate, dest, mode, owner, force, password

Create or delete a Java keystore in JKS format for a given certificate.

Jboss *arguments

Deploy applications to JBoss

Arguments: src, deploy_path, state, deployment

Deploy applications to JBoss standalone using the filesystem.

Jenkins Job *arguments

Manage jenkins jobs

Arguments: name, url, enabled, state, token, user, password, config

Manage Jenkins jobs by using Jenkins REST API.

Jenkins Job Info *arguments

Get information about Jenkins jobs

Arguments: name, color, glob, url, token, user, password, validate_certs

This module can be used to query information about which Jenkins jobs which already exists. This module was called C(jenkins_job_info) before Ansible 2.9. The usage did not change.

Jenkins Plugin *arguments

Add or remove Jenkins plugin

Arguments: jenkins_home, group, name, url, updates_url, with_dependencies, state, version, updates_expiration, mode, timeout, owner

Ansible module which helps to manage Jenkins plugins.

Jenkins Script *arguments

Executes a groovy script in the jenkins instance

Arguments: password, user, timeout, script, url, args, validate_certs

The C(jenkins_script) module takes a script plus a dict of values to use within the script and returns the result of the script being run.

Jira *arguments

create and modify issues in a JIRA instance

Arguments: username, comment, description, assignee, inwardissue, operation, password, linktype, issue, fields, outwardissue, uri, summary, project, status, timeout, issuetype, validate_certs

Create and modify issues in a JIRA instance.

Junos Banner *arguments

Manage multiline banners on Juniper JUNOS devices

Arguments: active, text, state, banner

This will configure both login and motd banners on network devices. It allows playbooks to add or remote banner text from the active running configuration.

Junos Command *arguments

Run arbitrary commands on an Juniper JUNOS device

Arguments: retries, commands, wait_for, rpcs, interval, display, match

Sends an arbitrary set of commands to an JUNOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Junos Config *arguments

Manage configuration on devices running Juniper JUNOS

Arguments: comment, src, backup_options, rollback, confirm, lines, update, replace, confirm_commit, zeroize, src_format, check_commit, backup

This module provides an implementation for working with the active configuration running on Juniper JUNOS devices. It provides a set of arguments for loading configuration, performing rollback operations and zeroing the active configuration on the device.

Junos Facts *arguments

Collect facts from remote devices running Juniper Junos

Arguments: config_format, gather_subset, gather_network_resources

Collects fact information from a remote device running the Junos operating system. By default, the module will collect basic fact information from the device to be included with the hostvars. Additional fact information can be collected based on the configured set of arguments.

Junos Interfaces *arguments

Manages interface attributes of Juniper Junos OS network devices.

Arguments: state, config

This module manages the interfaces on Juniper Junos OS network devices.

Junos L2 Interfaces *arguments

Manage Layer-2 interface on Juniper JUNOS devices

Arguments: state, config

This module provides declarative management of a Layer-2 interface on Juniper JUNOS devices.

Junos L3 Interfaces *arguments

Manage Layer 3 interface on Juniper JUNOS devices

Arguments: state, config

This module provides declarative management of a Layer 3 interface on Juniper JUNOS devices

Junos Lacp *arguments

Manage Global Link Aggregation Control Protocol (LACP) on Juniper Junos devices

Arguments: state, config

This module provides declarative management of global LACP on Juniper Junos network devices.

Junos Lacp Interfaces *arguments

Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on Juniper JUNOS devices.

Arguments: state, config

This module manages Link Aggregation Control Protocol (LACP) attributes of interfaces on Juniper JUNOS devices.

Junos Lag Interfaces *arguments

Manage Link Aggregation on Juniper JUNOS devices.

Arguments: state, config

This module manages properties of Link Aggregation Group on Juniper JUNOS devices.

Junos Lldp Global *arguments

Manage link layer discovery protocol (LLDP) attributes on Juniper JUNOS devices.

Arguments: state, config

This module manages link layer discovery protocol (LLDP) attributes on Juniper JUNOS devices.

Junos Lldp Interfaces *arguments

Manage link layer discovery protocol (LLDP) attributes of interfaces on Juniper JUNOS devices

Arguments: state, config

This module manages link layer discovery protocol (LLDP) attributes of interfaces on Juniper JUNOS devices.

Junos Logging *arguments

Manage logging on network devices

Arguments: files, name, level, dest, facility, aggregate, state, active, rotate_frequency, size

This module provides declarative management of logging on Juniper JUNOS devices.

Junos Netconf *arguments

Configures the Junos Netconf system service

Arguments: state, netconf_port

This module provides an abstraction that enables and configures the netconf system service running on Junos devices. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242. If the C(netconf_port) is not mentioned in the task by default netconf will be enabled on port 830 only.

Junos Package *arguments

Installs packages on remote devices running Junos

Arguments: src, force, no_copy, reboot, issu, version, force_host, validate

This module can install new and updated packages on remote devices running Junos. The module will compare the specified package with the one running on the remote device and install the specified version if there is a mismatch

Junos Ping *arguments

Tests reachability using ping from devices running Juniper JUNOS

Arguments: count, dest, interval, source, state, ttl, interface, size

Tests reachability using ping from devices running Juniper JUNOS to a remote destination. Tested against Junos (17.3R1.10) For a general purpose network module, see the M(net_ping) module. For Windows targets, use the M(win_ping) module instead. For targets running Python, use the M(ping) module instead.

Junos Rpc *arguments

Runs an arbitrary RPC over NetConf on an Juniper JUNOS device

Arguments: output, rpc, args, attrs

Sends a request to the remote device running JUNOS to execute the specified RPC using the NetConf transport. The reply is then returned to the playbook in the C(xml) key. If an alternate output format is requested, the reply is transformed to the requested output.

Junos Scp *arguments

Transfer files from or to remote devices running Junos

Arguments: dest, src, recursive, remote_src

This module transfers files via SCP from or to remote devices running Junos.

Junos Static Route *arguments

Manage static IP routes on Juniper JUNOS network devices

Arguments: qualified_next_hop, aggregate, state, next_hop, preference, qualified_preference, address, active

This module provides declarative management of static IP routes on Juniper JUNOS network devices.

Junos System *arguments

Manage the system attributes on Juniper JUNOS devices

Arguments: name_servers, state, active, domain_search, hostname, domain_name

This module provides declarative management of node system attributes on Juniper JUNOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Junos User *arguments

Manage local user accounts on Juniper JUNOS devices

Arguments: encrypted_password, name, purge, aggregate, state, role, full_name, active, sshkey

This module manages locally configured user accounts on remote network devices running the JUNOS operating system. It provides a set of arguments for creating, removing and updating locally defined accounts

Junos Vlans *arguments

Create and manage VLAN configurations on Junos OS

Arguments: state, config

This module creates and manages VLAN configurations on Junos OS.

Junos Vrf *arguments

Manage the VRF definitions on Juniper JUNOS devices

Arguments: target, interfaces, name, rd, table_label, state, aggregate, active, description

This module provides declarative management of VRF definitions on Juniper JUNOS devices. It allows playbooks to manage individual or the entire VRF collection.

K 8 S *arguments

Manage Kubernetes (K8s) objects

Arguments: append_hash, merge_type, wait_sleep, wait_condition, wait_timeout, apply, validate, wait

Use the OpenShift Python client to perform CRUD operations on K8s objects. Pass the object definition from a source file or inline. See examples for reading files and using Jinja templates or vault-encrypted files. Access to the full range of K8s APIs. Use the M(k8s_info) module to obtain a list of items about an object of type C(kind) Authenticate using either a config file, certificates, password or token. Supports check mode.

K8s Auth *arguments

Authenticate to Kubernetes clusters which require an explicit login step

Arguments: username, host, password, ca_cert, api_key, validate_certs, state

This module handles authenticating to Kubernetes clusters requiring I(explicit) authentication procedures, meaning ones where a client logs in (obtains an authentication token), performs API operations using said token and then logs out (revokes the token). An example of a Kubernetes distribution requiring this module is OpenShift. On the other hand a popular configuration for username+password authentication is one utilizing HTTP Basic Auth, which does not involve any additional login/logout steps (instead login credentials can be attached to each and every API call performed) and as such is handled directly by the C(k8s) module (and other resource–specific modules) by utilizing the C(host), C(username) and C(password) parameters. Please consult your preferred module's documentation for more details.

K8s Info *arguments

Describe Kubernetes (K8s) objects

Arguments: kind, field_selectors, name, namespace, label_selectors, api_version

Use the OpenShift Python client to perform read operations on K8s objects. Access to the full range of K8s APIs. Authenticate using either a config file, certificates, password or token. Supports check mode. This module was called C(k8s_facts) before Ansible 2.9. The usage did not change.

K8s Scale *arguments

Set a new size for a Deployment, ReplicaSet, Replication Controller, or Job.

Arguments:

Similar to the kubectl scale command. Use to set the number of replicas for a Deployment, ReplicaSet, or Replication Controller, or the parallelism attribute of a Job. Supports check mode.

K8s Service *arguments

Manage Services on Kubernetes

Arguments: merge_type, force, name, namespace, resource_definition, state, selector, type, ports

Use Openshift Python SDK to manage Services on Kubernetes

Kernel Blacklist *arguments

Blacklist kernel modules

Arguments: blacklist_file, state, name

Add or remove kernel modules from blacklist.

Keycloak Client *arguments

Allows administration of Keycloak clients via Keycloak API

Arguments: default_roles, protocol, use_template_config, authorization_settings, frontchannel_logout, use_template_scope, registration_access_token, authorization_services_enabled, standard_flow_enabled, direct_access_grants_enabled, id, surrogate_auth_required, implicit_flow_enabled, node_re_registration_timeout, root_url, realm, base_url, web_origins, full_scope_allowed, secret, bearer_only, not_before, redirect_uris, description, registered_nodes, state, client_id, public_client, service_accounts_enabled, name, client_authenticator_type, admin_url, enabled, protocol_mappers, client_template, use_template_mappers, attributes, consent_required

This module allows the administration of Keycloak clients via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at U(http://www.keycloak.org/docs-api/3.3/rest-api/). Aliases are provided so camelCased versions can be used as well. The Keycloak API does not always sanity check inputs e.g. you can set SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful. If you do not specify a setting, usually a sensible default is chosen.

Keycloak Clienttemplate *arguments

Allows administration of Keycloak client templates via Keycloak API

Arguments: protocol, description, protocol_mappers, full_scope_allowed, state, attributes, realm, id, name

This module allows the administration of Keycloak client templates via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at U(http://www.keycloak.org/docs-api/3.3/rest-api/) The Keycloak API does not always enforce for only sensible settings to be used -- you can set SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful. If you do not specify a setting, usually a sensible default is chosen.

Keycloak Group *arguments

Allows administration of Keycloak groups via Keycloak API

Arguments: attributes, state, realm, name, id

This module allows you to add, remove or modify Keycloak groups via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at U(http://www.keycloak.org/docs-api/3.3/rest-api/). Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API. When updating a group, where possible provide the group ID to the module. This removes a lookup to the API to translate the name into the group ID.

Kibana Plugin *arguments

Manage Kibana plugins

Arguments: force, name, url, state, version, timeout, plugin_dir, plugin_bin

This module can be used to manage Kibana plugins.

Kinesis Stream *arguments

Manage a Kinesis Stream.

Arguments: name, tags, encryption_type, retention_period, shards, encryption_state, state, wait_timeout, key_id, wait

Create or Delete a Kinesis Stream. Update the retention period of a Kinesis Stream. Update Tags on a Kinesis Stream. Enable/disable server side encryption on a Kinesis Stream.

Known Hosts *arguments

Add or remove a host from the C(known_hosts) file

Arguments: path, state, hash_host, name, key

The C(known_hosts) module lets you add or remove a host keys from the C(known_hosts) file. Starting at Ansible 2.2, multiple entries per host are allowed, but only one for each key type supported by ssh. This is useful if you're going to want to use the M(git) module over ssh, for example. If you have a very large number of host keys to manage, you will find the M(template) module more useful.

Kubevirt Cdi Upload *arguments

Upload local VM images to CDI Upload Proxy.

Arguments: merge_type, pvc_namespace, upload_host, path, upload_host_validate_certs, pvc_name

Use Openshift Python SDK to create UploadTokenRequest objects. Transfer contents of local files to the CDI Upload Proxy.

Kubevirt Preset *arguments

Manage KubeVirt virtual machine presets

Arguments: state, namespace, name, selector

Use Openshift Python SDK to manage the state of KubeVirt virtual machine presets.

Kubevirt Pvc *arguments

Manage PVCs on Kubernetes

Arguments: force, labels, selector, wait_timeout, cdi_source, storage_class_name, access_modes, volume_mode, wait, merge_type, name, namespace, resource_definition, state, volume_name, size, annotations

Use Openshift Python SDK to manage PVCs on Kubernetes Support Containerized Data Importer out of the box

Kubevirt Rs *arguments

Manage KubeVirt virtual machine replica sets

Arguments: state, selector, namespace, name, replicas

Use Openshift Python SDK to manage the state of KubeVirt virtual machine replica sets.

Kubevirt Template *arguments

Manage KubeVirt templates

Arguments: icon_class, description, default_nic, editable, documentation_url, objects, long_description, name, merge_type, display_name, parameters, default_volume, support_url, provider_display_name, namespace, default_disk, version, default_network

Use Openshift Python SDK to manage the state of KubeVirt templates.

Kubevirt Vm *arguments

Manage KubeVirt virtual machine

Arguments: datavolumes, name, template, ephemeral, namespace, state, template_parameters

Use Openshift Python SDK to manage the state of KubeVirt virtual machines.

Lambda *arguments

Manage AWS Lambda functions

Arguments: description, tags, s3_key, zip_file, s3_object_version, memory_size, dead_letter_arn, name, s3_bucket, state, handler, role, timeout, environment_variables, runtime, vpc_subnet_ids, vpc_security_group_ids

Allows for the management of Lambda functions.

Lambda Alias *arguments

Creates, updates or deletes AWS Lambda function aliases.

Arguments: function_name, state, version, description, name

This module allows the management of AWS Lambda functions aliases via the Ansible framework. It is idempotent and supports "Check" mode. Use module M(lambda) to manage the lambda function itself and M(lambda_event) to manage event source mappings.

Lambda Event *arguments

Creates, updates or deletes AWS Lambda function event mappings.

Arguments: source_params, state, version, event_source, alias, lambda_function_arn

This module allows the management of AWS Lambda function event source mappings such as DynamoDB and Kinesis stream events via the Ansible framework. These event source mappings are relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. It is idempotent and supports "Check" mode. Use module M(lambda) to manage the lambda function itself and M(lambda_alias) to manage function aliases.

Lambda Info *arguments

Gathers AWS Lambda function details

Arguments: query, event_source_arn, function_name

Gathers various details related to Lambda functions, including aliases, versions and event source mappings. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases and M(lambda_event) to manage lambda event source mappings.

Lambda Policy *arguments

Creates, updates or deletes AWS Lambda policy statements.

Arguments: event_source_token, statement_id, alias, state, version, action, source_arn, function_name, source_account, principal

This module allows the management of AWS Lambda policy statements. It is idempotent and supports "Check" mode. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases, M(lambda_event) to manage event source mappings such as Kinesis streams, M(execute_lambda) to execute a lambda function and M(lambda_info) to gather information relating to one or more lambda functions.

Layman *arguments

Manage Gentoo overlays

Arguments: list_url, validate_certs, name, state

Uses Layman to manage an additional repositories for the Portage package manager on Gentoo Linux. Please note that Layman must be installed on a managed node prior using this module.

Ldap Attr *arguments

Add or remove LDAP attribute values

Arguments: state, values, name

Add or remove LDAP attribute values.

Ldap Entry *arguments

Add or remove LDAP entries.

Arguments: objectClass, attributes, state

Add or remove LDAP entries. This module only asserts the existence or non-existence of an LDAP entry, not its attributes. To assert the attribute values of an entry, see M(ldap_attr).

Ldap Passwd *arguments

Set passwords in LDAP.

Arguments: passwd

Set a password for an LDAP entry. This module only asserts that a given password is valid for a given entry. To assert the existence of an entry, see M(ldap_entry).

Librato Annotation *arguments

create an annotation in librato

Arguments: description, links, title, start_time, name, source, end_time, api_key, user

Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically

Lightsail *arguments

Create or delete a virtual machine instance in AWS Lightsail

Arguments: name, zone, blueprint_id, user_data, key_pair_name, state, wait_timeout, bundle_id, wait

Creates or instances in AWS Lightsail and optionally wait for it to be 'running'.

Lineinfile *arguments

Manage lines in text files

Arguments: insertbefore, create, others, backrefs, state, firstmatch, insertafter, regexp, path, backup, line

This module ensures a particular line is in a file, or replace an existing line using a back-referenced regular expression. This is primarily useful when you want to change a single line in a file only. See the M(replace) module if you want to change multiple, similar lines or check M(blockinfile) if you want to insert/update/remove a block of lines in a file. For other cases, see the M(copy) or M(template) modules.

Linode *arguments

Manage instances on the Linode Public Cloud

Arguments: alert_diskio_enabled, additional_disks, alert_bwin_enabled, payment_term, kernel_id, alert_bwin_threshold, alert_cpu_enabled, alert_bwquota_enabled, linode_id, alert_diskio_threshold, wait_timeout, private_ip, watchdog, password, ssh_pub_key, wait, datacenter, alert_bwquota_threshold, backupweeklyday, name, displaygroup, alert_cpu_threshold, alert_bwout_enabled, state, swap, alert_bwout_threshold, distribution, api_key, plan

Manage Linode Public Cloud instances and optionally wait for it to be 'running'.

Linode V4 *arguments

Manage instances on the Linode cloud.

Arguments: root_pass, group, tags, access_token, region, label, state, authorized_keys, type, image

Manage instances on the Linode cloud.

Listen Ports Facts *arguments

Gather facts on processes listening on TCP and UDP ports.

Arguments:

Gather facts on processes listening on TCP and UDP ports.

Lldp *arguments

get details reported by lldp

Arguments:

Reads data out of lldpctl

Locale Gen *arguments

Creates or removes locales

Arguments: state, name

Manages locales by editing /etc/locale.gen and invoking locale-gen.

Logentries *arguments

Module for tracking logs via logentries.com

Arguments: path, state, name, logtype

Sends logs to LogEntries in realtime

Logentries Msg *arguments

Send a message to logentries.

Arguments: msg, token, api, port

Send a message to logentries

Logicmonitor *arguments

Manage your LogicMonitor account through Ansible Playbooks

Arguments: displayname, description, company, user, groups, duration, password, collector, id, alertenable, target, hostname, properties, starttime, action, fullpath

LogicMonitor is a hosted, full-stack, infrastructure monitoring platform. This module manages hosts, host groups, and collectors within your LogicMonitor account.

Logicmonitor Facts *arguments

Collect facts about LogicMonitor objects

Arguments: displayname, target, company, hostname, user, fullpath, password, collector

LogicMonitor is a hosted, full-stack, infrastructure monitoring platform. This module collects facts about hosts and host groups within your LogicMonitor account.

Logstash Plugin *arguments

Manage Logstash plugins

Arguments: proxy_port, state, version, name, proxy_host, plugin_bin

Manages Logstash plugins.

Luks Device *arguments

Manage encrypted (LUKS) devices

Arguments: remove_keyfile, force_remove_last_key, name, device, keyfile, state, new_keyfile

Module manages L(LUKS,https://en.wikipedia.org/wiki/Linux_Unified_Key_Setup) on given device. Supports creating, destroying, opening and closing of LUKS container and adding or removing new keys.

Lvg *arguments

Configure LVM volume groups

Arguments: vg_options, pvs, force, vg, pesize, pv_options, state

This module creates, removes or resizes volume groups.

Lvol *arguments

Configure LVM logical volumes

Arguments: pvs, force, vg, lv, resizefs, state, thinpool, snapshot, active, shrink, opts, size

This module creates, removes or resizes logical volumes.

Lxc Container *arguments

Manage LXC Containers

Arguments: archive_path, zfs_root, container_log_level, template_options, container_command, clone_name, lxc_path, container_config, fs_type, archive, vg_name, clone_snapshot, container_log, name, lv_name, fs_size, archive_compression, backing_store, state, thinpool, template, directory, config

Management of LXC containers

Lxca Cmms *arguments

Custom module for lxca cmms inventory utility

Arguments: command_options, uuid, chassis

This module returns/displays a inventory details of cmms

Lxca Nodes *arguments

Custom module for lxca nodes inventory utility

Arguments: command_options, uuid, chassis

This module returns/displays a inventory details of nodes

Lxd Container *arguments

Manage LXD Containers

Arguments: name, source, url, config, ephemeral, snap_url, wait_for_ipv4_addresses, state, devices, timeout, client_key, trust_password, client_cert, force_stop, architecture

Management of LXD containers

Lxd Profile *arguments

Manage LXD profiles

Arguments: new_name, name, url, config, description, devices, state, snap_url, trust_password, client_cert, client_key

Management of LXD profiles

Macports *arguments

Package manager for MacPorts

Arguments: variant, state, upgrade, selfupdate, name

Manages MacPorts packages (ports)

Mail *arguments

Send an email

Arguments: body, username, secure, cc, host, password, port, to, subject, from, headers, charset, bcc, attach, timeout, subtype

This module is useful for sending emails from playbooks. One may wonder why automate sending emails? In complex environments there are from time to time processes that cannot be automated, either because you lack the authority to make it so, or because not everyone agrees to a common approach. If you cannot automate a specific step, but the step is non-blocking, sending out an email to the responsible party to make them perform their part of the bargain is an elegant way to put the responsibility in someone else's lap. Of course sending out a mail can be equally useful as a way to notify one or more people in a team that a specific action has been (successfully) taken.

Make *arguments

Run targets in a Makefile

Arguments: chdir, params, target, file

Run targets in a Makefile.

Manageiq Alert Profiles *arguments

Configuration of alert profiles for ManageIQ

Arguments: notes, alerts, state, resource_type, name

The manageiq_alert_profiles module supports adding, updating and deleting alert profiles in ManageIQ.

Manageiq Alerts *arguments

Configuration of alerts in ManageIQ

Arguments: state, description, expression, expression_type, enabled, options, resource_type

The manageiq_alerts module supports adding, updating and deleting alerts in ManageIQ.

Manageiq Group *arguments

Management of groups in ManageIQ.

Arguments: description, tenant_id, belongsto_filters_merge_mode, role_id, managed_filters, state, role, managed_filters_merge_mode, belongsto_filters, tenant

The manageiq_group module supports adding, updating and deleting groups in ManageIQ.

Manageiq Policies *arguments

Management of resource policy_profiles in ManageIQ.

Arguments: state, resource_name, policy_profiles, resource_type

The manageiq_policies module supports adding and deleting policy_profiles in ManageIQ.

Manageiq Provider *arguments

Management of provider in ManageIQ.

Arguments: ssh_keypair, host_default_vnc_port_start, tenant_mapping_enabled, metrics, azure_tenant_id, provider_region, subscription, name, zone, host_default_vnc_port_end, alerts, project, state, provider, type, api_version

The manageiq_provider module supports adding, updating, and deleting provider in ManageIQ.

Manageiq Tags *arguments

Management of resource tags in ManageIQ.

Arguments: state, resource_name, resource_type, tags

The manageiq_tags module supports adding, updating and deleting tags in ManageIQ.

Manageiq Tenant *arguments

Management of tenants in ManageIQ.

Arguments: parent_id, state, name, parent, quotas, description

The manageiq_tenant module supports adding, updating and deleting tenants in ManageIQ.

Manageiq User *arguments

Management of users in ManageIQ.

Arguments: update_password, group, name, password, userid, state, email

The manageiq_user module supports adding, updating and deleting users in ManageIQ.

Matrix *arguments

Send notifications to matrix

Arguments: token, msg_plain, user_id, msg_html, hs_url, room_id, password

This module sends html formatted notifications to matrix rooms.

Mattermost *arguments

Send Mattermost notifications

Arguments: username, icon_url, url, text, api_key, validate_certs, channel

Sends notifications to U(http://your.mattermost.url) via the Incoming WebHook integration.

Maven Artifact *arguments

Downloads an Artifact from a Maven Repository

Arguments: username, keep_name, group_id, artifact_id, extension, dest, validate_certs, headers, state, version, timeout, repository_url, password, verify_checksum, classifier

Downloads an artifact from a maven repository given the maven coordinates provided to the module. Can retrieve snapshots or release versions of the artifact and will resolve the latest available version if one is not available.

Memset Dns Reload *arguments

Request reload of Memset's DNS infrastructure,

Arguments: api_key, poll

Request a reload of Memset's DNS infrastructure, and optionally poll until it finishes.

Memset Memstore Info *arguments

Retrieve Memstore product usage information.

Arguments: api_key, name

Retrieve Memstore product usage information. This module was called C(memset_memstore_facts) before Ansible 2.9. The usage did not change.

Memset Server Info *arguments

Retrieve server information.

Arguments: api_key, name

Retrieve server information. This module was called C(memset_server_facts) before Ansible 2.9. The usage did not change.

Memset Zone *arguments

Creates and deletes Memset DNS zones.

Arguments: state, api_key, force, name, ttl

Manage DNS zones in a Memset account.

Memset Zone Domain *arguments

Create and delete domains in Memset DNS zones.

Arguments: state, api_key, domain, zone

Manage DNS zone domains in a Memset account.

Memset Zone Record *arguments

Create and delete records in Memset DNS zones.

Arguments: priority, zone, address, relative, record, state, ttl, api_key, type

Manage DNS records in a Memset account.

Meraki Admin *arguments

Manage administrators in the Meraki cloud

Arguments: org_name, state, name, tags, org_access, email, networks

Allows for creation, management, and visibility into administrators within Meraki.

Meraki Config Template *arguments

Manage configuration templates in the Meraki cloud

Arguments: org_name, state, config_template, net_name, org_id, auto_bind, net_id

Allows for querying, deleting, binding, and unbinding of configuration templates.

Meraki Content Filtering *arguments

Edit Meraki MX content filtering policies

Arguments: subset, blocked_urls, auth_key, blocked_categories, state, category_list_size, net_name, allowed_urls, net_id

Allows for setting policy on content filtering.

Meraki Device *arguments

Manage devices in the Meraki cloud

Arguments: model, lldp_cdp_timespan, tags, move_map_marker, hostname, note, serial_uplink, state, net_name, address, lat, lng, net_id, serial, serial_lldp_cdp

Visibility into devices associated to a Meraki environment.

Meraki Firewalled Services *arguments

Edit firewall policies for administrative network services

Arguments: org_name, auth_key, service, org_id, allowed_ips, access, state, net_name, net_id

Allows for setting policy firewalled services for Meraki network devices.

Meraki Malware *arguments

Manage Malware Protection in the Meraki cloud

Arguments: state, allowed_files, net_name, allowed_urls, net_id, mode

Fully configure malware protection in a Meraki environment.

Meraki Mr L3 Firewall *arguments

Manage MR access point layer 3 firewalls in the Meraki cloud

Arguments: allow_lan_access, state, net_name, rules, ssid_name, number, net_id

Allows for creation, management, and visibility into layer 3 firewalls implemented on Meraki MR access points. Module is not idempotent as of current release.

Meraki Mx L3 Firewall *arguments

Manage MX appliance layer 3 firewalls in the Meraki cloud

Arguments: rules, state, net_id, syslog_default_rule, net_name

Allows for creation, management, and visibility into layer 3 firewalls implemented on Meraki MX firewalls.

Meraki Mx L7 Firewall *arguments

Manage MX appliance layer 7 firewalls in the Meraki cloud

Arguments: rules, state, net_name, categories, net_id

Allows for creation, management, and visibility into layer 7 firewalls implemented on Meraki MX firewalls.

Meraki Nat *arguments

Manage NAT rules in Meraki cloud

Arguments: subset, one_to_many, one_to_one, org_id, state, net_name, port_forwarding, net_id

Allows for creation, management, and visibility of NAT rules (1:1, 1:many, port forwarding) within Meraki.

Meraki Network *arguments

Manage networks in the Meraki cloud

Arguments: enable_vlans, tags, disable_my_meraki, state, net_name, enable_remote_status_page, enable_my_meraki, timezone, type, net_id

Allows for creation, management, and visibility into networks within Meraki.

Meraki Organization *arguments

Manage organizations in the Meraki cloud

Arguments: org_name, state, org_id, clone

Allows for creation, management, and visibility into organizations within Meraki.

Meraki Snmp *arguments

Manage organizations in the Meraki cloud

Arguments: v3_auth_pass, v3_priv_mode, users, v3_auth_mode, v3_enabled, access, v3_priv_pass, state, peer_ips, net_name, net_id, v2c_enabled, community_string

Allows for management of SNMP settings for Meraki.

Meraki Ssid *arguments

Manage wireless SSIDs in the Meraki cloud

Arguments: psk, net_name, ip_assignment_mode, state, encryption_mode, number, radius_load_balancing_policy, auth_mode, per_client_bandwidth_limit_up, concentrator_network_id, radius_coa_enabled, band_selection, default_vlan_id, vlan_id, ap_tags_vlan_ids, name, min_bitrate, use_vlan_tagging, enabled, radius_accounting_enabled, walled_garden_ranges, walled_garden_enabled, wpa_encryption_mode, radius_servers, radius_accounting_servers, per_client_bandwidth_limit_down, net_id, radius_failover_policy, splash_page

Allows for management of SSIDs in a Meraki wireless environment.

Meraki Static Route *arguments

Manage static routes in the Meraki cloud

Arguments: subnet, name, enabled, route_id, state, reserved_ip_ranges, gateway_ip, net_name, net_id, fixed_ip_assignments

Allows for creation, management, and visibility into static routes within Meraki.

Meraki Switchport *arguments

Manage switchports on a switch in the Meraki cloud

Arguments: isolation_enabled, tags, vlan, number, rstp_enabled, voice_vlan, allowed_vlans, serial, name, access_policy_number, enabled, poe_enabled, state, stp_guard, type, link_negotiation

Allows for management of switchports settings for Meraki MS switches.

Meraki Syslog *arguments

Manage syslog server settings in the Meraki cloud.

Arguments: state, net_id, net_name, auth_key, servers

Allows for creation and management of Syslog servers within Meraki.

Meraki Vlan *arguments

Manage VLANs in the Meraki cloud

Arguments: subnet, name, appliance_ip, dns_nameservers, state, net_name, reserved_ip_range, vpn_nat_subnet, net_id, vlan_id, fixed_ip_assignments

Create, edit, query, or delete VLANs in a Meraki environment.

Meraki Webhook *arguments

Manage webhooks configured in the Meraki cloud

Arguments: name, url, shared_secret, state, net_name, webhook_id, test, test_id, net_id

Configure and query information about webhooks within the Meraki cloud.

Meta *arguments

Execute Ansible 'actions'

Arguments: free_form

Meta tasks are a special kind of task which can influence Ansible internal execution or state. Meta tasks can be used anywhere within your playbook. This module is also supported for Windows targets.

Mksysb *arguments

Generates AIX mksysb rootvg backups.

Arguments: exclude_files, name, software_packing, use_snapshot, create_map_files, extended_attrs, backup_crypt_files, new_image_data, exclude_wpar_files, backup_dmapi_fs, storage_path

This module manages a basic AIX mksysb (image) of rootvg.

Modprobe *arguments

Load or unload kernel modules

Arguments: state, params, name

Load or unload kernel modules.

Mongodb Parameter *arguments

Change an administrative parameter on a MongoDB server.

Arguments: login_port, database, login_user, login_host, login_database, param, ssl, param_type, value, login_password, replica_set

Change an administrative parameter on a MongoDB server.

Mongodb Replicaset *arguments

Initialises a MongoDB replicaset.

Arguments: login_port, ssl_cert_reqs, election_timeout_millis, login_user, login_host, login_database, arbiter_at_index, heartbeat_timeout_secs, ssl, members, login_password, chaining_allowed, protocol_version, validate, replica_set

Initialises a MongoDB replicaset in a new deployment. Validates the replicaset name for existing deployments.

Mongodb Shard *arguments

Add and remove shards from a MongoDB Cluster.

Arguments: login_port, login_user, login_host, login_database, ssl_cert_reqs, shard, ssl, state, login_password

Add and remove shards from a MongoDB Cluster.

Mongodb User *arguments

Adds or removes a user from a MongoDB database.

Arguments: login_port, update_password, name, roles, database, login_user, login_host, login_database, ssl_cert_reqs, ssl, state, login_password, password, replica_set

Adds or removes a user from a MongoDB database.

Monit *arguments

Manage the state of a program monitored via Monit

Arguments: state, name, timeout

Manage the state of a program monitored via I(Monit)

Mount *arguments

Control active and configured mount points

Arguments: src, dump, passno, fstab, boot, fstype, state, path, backup, opts

This module controls active and configured mount points in C(/etc/fstab).

Mqtt *arguments

Publish a message on an MQTT topic for the IoT

Arguments: username, tls_version, qos, ca_cert, port, client_cert, server, topic, client_id, retain, password, payload, client_key

Publish a message on an MQTT topic.

Mso Label *arguments

Manage labels

Arguments: state, type, label

Manage labels on Cisco ACI Multi-Site.

Mso Role *arguments

Manage roles

Arguments: role, state, display_name, description, permissions

Manage roles on Cisco ACI Multi-Site.

Mso Schema *arguments

Manage schemas

Arguments: templates, state, sites, schema

Manage schemas on Cisco ACI Multi-Site.

Mso Schema Site *arguments

Manage sites in schemas

Arguments: state, site, template, schema

Manage sites on Cisco ACI Multi-Site.

Mso Schema Site Anp *arguments

Manage site-local Application Network Profiles (ANPs) in schema template

Arguments: state, anp, site, template, schema

Manage site-local ANPs in schema template on Cisco ACI Multi-Site.

Mso Schema Site Anp Epg *arguments

Manage site-local Endpoint Groups (EPGs) in schema template

Arguments: state, anp, template, epg, site, schema

Manage site-local EPGs in schema template on Cisco ACI Multi-Site.

Mso Schema Site Anp Epg Domain *arguments

Manage site-local EPG domains in schema template

Arguments: switch_type, allow_micro_segmentation, template, vlan_encap_mode, site, anp, domain_association_type, resolution_immediacy, micro_seg_vlan, enhanced_lagpolicy_dn, domain_profile, micro_seg_vlan_type, switching_mode, enhanced_lagpolicy_name, port_encap_vlan_type, state, deployment_immediacy, epg, port_encap_vlan, schema

Manage site-local EPG domains in schema template on Cisco ACI Multi-Site.

Mso Schema Site Anp Epg Staticleaf *arguments

Manage site-local EPG static leafs in schema template

Arguments: leaf, vlan, site, state, anp, template, epg, pod, schema

Manage site-local EPG static leafs in schema template on Cisco ACI Multi-Site.

Mso Schema Site Anp Epg Staticport *arguments

Manage site-local EPG static ports in schema template

Arguments: leaf, template, vlan, site, state, anp, mode, deployment_immediacy, epg, path, pod, type, schema

Manage site-local EPG static ports in schema template on Cisco ACI Multi-Site.

Mso Schema Site Anp Epg Subnet *arguments

Manage site-local EPG subnets in schema template

Arguments: subnet, epg, description, no_default_gateway, site, state, anp, template, scope, shared, schema

Manage site-local EPG subnets in schema template on Cisco ACI Multi-Site.

Mso Schema Site Bd *arguments

Manage site-local Bridge Domains (BDs) in schema template

Arguments: bd, state, template, site, host_route, schema

Manage site-local BDs in schema template on Cisco ACI Multi-Site.

Mso Schema Site Bd L3out *arguments

Manage site-local BD l3out's in schema template

Arguments: bd, l3out, state, template, site, schema

Manage site-local BDs l3out's in schema template on Cisco ACI Multi-Site.

Mso Schema Site Bd Subnet *arguments

Manage site-local BD subnets in schema template

Arguments: bd, subnet, description, no_default_gateway, site, state, template, scope, shared, schema

Manage site-local BD subnets in schema template on Cisco ACI Multi-Site.

Mso Schema Site Vrf *arguments

Manage site-local VRFs in schema template

Arguments: state, schema, vrf, template, site

Manage site-local VRFs in schema template on Cisco ACI Multi-Site.

Mso Schema Site Vrf Region *arguments

Manage site-local VRF regions in schema template

Arguments: state, vrf, template, region, site, schema

Manage site-local VRF regions in schema template on Cisco ACI Multi-Site.

Mso Schema Site Vrf Region Cidr *arguments

Manage site-local VRF region CIDRs in schema template

Arguments: region, site, primary, state, vrf, template, cidr, schema

Manage site-local VRF region CIDRs in schema template on Cisco ACI Multi-Site.

Mso Schema Site Vrf Region Cidr Subnet *arguments

Manage site-local VRF regions in schema template

Arguments: subnet, zone, region, site, state, vrf, template, cidr, schema

Manage site-local VRF regions in schema template on Cisco ACI Multi-Site.

Mso Schema Template *arguments

Manage templates in schemas

Arguments: state, display_name, tenant, template, schema

Manage templates on Cisco ACI Multi-Site.

Mso Schema Template Anp *arguments

Manage Application Network Profiles (ANPs) in schema templates

Arguments: anp, state, display_name, template, schema

Manage ANPs in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Anp Epg *arguments

Manage Endpoint Groups (EPGs) in schema templates

Arguments: bd, subnets, useg_epg, display_name, intersite_multicaste_source, state, preferred_group, vrf, template, epg, anp, intra_epg_isolation, schema

Manage EPGs in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Anp Epg Contract *arguments

Manage EPG contracts in schema templates

Arguments: state, anp, template, epg, contract, schema

Manage EPG contracts in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Anp Epg Subnet *arguments

Manage EPG subnets in schema templates

Arguments: subnet, epg, description, no_default_gateway, state, anp, template, scope, shared, schema

Manage EPG subnets in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Bd *arguments

Manage Bridge Domains (BDs) in schema templates

Arguments: bd, subnets, display_name, layer2_stretch, optimize_wan_bandwidth, state, layer3_multicast, template, layer2_unknown_unicast, schema, intersite_bum_traffic, vrf

Manage BDs in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Bd Subnet *arguments

Manage BD subnets in schema templates

Arguments: bd, subnet, description, no_default_gateway, state, template, scope, shared, schema

Manage BD subnets in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Contract Filter *arguments

Manage contract filters in schema templates

Arguments: template, filter_type, filter, state, contract_display_name, contract, filter_directives, filter_template, contract_scope, contract_filter_type, schema, filter_schema

Manage contract filters in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Deploy *arguments

Deploy schema templates to sites

Arguments: state, site, template, schema

Deploy schema templates to sites.

Mso Schema Template Externalepg *arguments

Manage external EPGs in schema templates

Arguments: state, display_name, vrf, template, externalepg, schema

Manage external EPGs in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Filter Entry *arguments

Manage filter entries in schema templates

Arguments: filter_display_name, description, arp_flag, fragments_only, stateful, tcp_session_rules, source_from, ip_protocol, display_name, source_to, ethertype, destination_from, filter, state, template, entry, destination_to, schema

Manage filter entries in schema templates on Cisco ACI Multi-Site.

Mso Schema Template L3out *arguments

Manage l3outs in schema templates

Arguments: l3out, state, display_name, vrf, template, schema

Manage l3outs in schema templates on Cisco ACI Multi-Site.

Mso Schema Template Vrf *arguments

Manage VRFs in schema templates

Arguments: state, display_name, layer3_multicast, template, vrf, schema

Manage VRFs in schema templates on Cisco ACI Multi-Site.

Mso Site *arguments

Manage sites

Arguments: apic_site_id, apic_password, labels, site, apic_username, state, location, urls

Manage sites on Cisco ACI Multi-Site.

Mso Tenant *arguments

Manage tenants

Arguments: state, display_name, description, sites, tenant, users

Manage tenants on Cisco ACI Multi-Site.

Mso User *arguments

Manage users

Arguments: first_name, last_name, roles, user_password, domain, phone, state, user, account_status, email

Manage users on Cisco ACI Multi-Site.

Mssql Db *arguments

Add or remove MSSQL databases from a remote host.

Arguments: autocommit, login_port, name, login_user, login_host, state, login_password, target

Add or remove MSSQL databases from a remote host.

Mysql Db *arguments

Add or remove MySQL databases from a remote host.

Arguments: target, encoding, collation, state, ignore_tables, quick, single_transaction, name

Add or remove MySQL databases from a remote host.

Mysql Info *arguments

Gather information about MySQL servers

Arguments: filter, login_db

Gathers information about MySQL servers.

Mysql Replication *arguments

Manage MySQL replication

Arguments: master_ssl_cert, master_auto_position, master_password, master_host, master_ssl_capath, master_ssl_ca, master_connect_retry, master_user, master_port, master_log_file, master_ssl_cipher, relay_log_file, master_ssl, master_ssl_key, mode, master_log_pos, relay_log_pos

Manages MySQL server replication, slave, master status get and change master host.

Mysql User *arguments

Adds or removes a user from a MySQL database

Arguments: update_password, name, encrypted, append_privs, sql_log_bin, host_all, state, host, check_implicit_admin, password, priv

Adds or removes a user from a MySQL database.

Mysql Variables *arguments

Manage MySQL global variables

Arguments: variable, value

Query / Set MySQL variables.

Na Elementsw Access Group *arguments

NetApp Element Software Manage Access Groups

Arguments: from_name, name, virtual_network_id, state, volumes, initiators, attributes, virtual_network_tags, account_id

Create, destroy, or update access groups on Element Software Cluster.

Na Elementsw Account *arguments

NetApp Element Software Manage Accounts

Arguments: status, state, element_username, attributes, from_name, target_secret, initiator_secret

Create, destroy, or update accounts on Element SW

Na Elementsw Admin Users *arguments

NetApp Element Software Manage Admin Users

Arguments: element_password, access, state, element_username, acceptEula

Create, destroy, or update admin users on SolidFire

Na Elementsw Backup *arguments

NetApp Element Software Create Backups

Arguments: dest_username, format, script_parameters, script, dest_hostname, dest_volume_id, dest_password, src_volume_id

Create backup

Na Elementsw Check Connections *arguments

NetApp Element Software Check connectivity to MVIP and SVIP.

Arguments: svip, skip, mvip

Used to test the management connection to the cluster. The test pings the MVIP and SVIP, and executes a simple API method to verify connectivity.

Na Elementsw Cluster *arguments

NetApp Element Software Create Cluster

Arguments: accept_eula, storage_virtual_ip, replica_count, management_virtual_ip, cluster_admin_username, cluster_admin_password, attributes, nodes

Initialize Element Software node ownership to form a cluster.

Na Elementsw Cluster Config *arguments

Configure Element SW Cluster

Arguments: encryption_at_rest, modify_cluster_full_threshold, enable_virtual_volumes, set_ntp_info

Configure Element Software cluster.

Na Elementsw Cluster Pair *arguments

NetApp Element Software Manage Cluster Pair

Arguments: dest_password, state, dest_mvip, dest_username

Create, delete cluster pair

Na Elementsw Cluster Snmp *arguments

Configure Element SW Cluster SNMP

Arguments: state, snmp_v3_enabled, networks, usm_users

Configure Element Software cluster SNMP.

Na Elementsw Drive *arguments

NetApp Element Software Manage Node Drives

Arguments: drive_id, state, node_id, force_during_bin_sync, force_during_upgrade

Add, Erase or Remove drive for nodes on Element Software Cluster.

Na Elementsw Initiators *arguments

Manage Element SW initiators

Arguments: initiators, state

Manage Element Software initiators that allow external clients access to volumes.

Na Elementsw Ldap *arguments

NetApp Element Software Manage ldap admin users

Arguments: authType, searchBindDN, groupSearchBaseDn, userSearchFilter, state, userDNTemplate, searchBindPassword, groupSearchCustomFilter, userSearchBaseDN, serverURIs, groupSearchType

Enable, disable ldap, and add ldap users

Na Elementsw Network Interfaces *arguments

NetApp Element Software Configure Node Network Interfaces

Arguments: mtu_1g, subnet_1g, lacp_10g, bond_mode_10g, virtual_network_tag, mtu_10g, dns_search_domains, ip_address_1g, subnet_10g, gateway_address_10g, lacp_1g, dns_nameservers, ip_address_10g, gateway_address_1g, bond_mode_1g, method

Configure Element SW Node Network Interfaces for Bond 1G and 10G IP address.

Na Elementsw Node *arguments

NetApp Element Software Node Operation

Arguments: state, node_id

Add, remove cluster node on Element Software Cluster.

Na Elementsw Snapshot *arguments

NetApp Element Software Manage Snapshots

Arguments: enable_remote_replication, username, src_snapshot_id, name, retention, state, snap_mirror_label, expiration_time, password, src_volume_id, account_id

Create, Modify or Delete Snapshot on Element OS Cluster.

Na Elementsw Snapshot Restore *arguments

NetApp Element Software Restore Snapshot

Arguments: src_volume_id, src_snapshot_id, dest_volume_name, account_id

Element OS Cluster restore snapshot to volume.

Na Elementsw Snapshot Schedule *arguments

NetApp Element Software Snapshot Schedules

Arguments: username, time_interval_days, account_id, time_interval_minutes, days_of_month_hours, paused, snapshot_name, days_of_week_weekdays, days_of_week_hours, password, retention, name, time_interval_hours, schedule_type, days_of_month_monthdays, state, volumes, days_of_month_minutes, days_of_week_minutes, starting_date, recurring

Create, destroy, or update accounts on ElementSW

Na Elementsw Vlan *arguments

NetApp Element Software Manage VLAN

Arguments: name, address_blocks, namespace, state, netmask, svip, attributes, vlan_tag, gateway

Create, delete, modify VLAN

Na Elementsw Volume *arguments

NetApp Element Software Manage Volumes

Arguments: username, enable512e, qos, name, size_unit, account_id, access, state, attributes, password, size

Create, destroy, or update volumes on ElementSW

Na Elementsw Volume Clone *arguments

NetApp Element Software Create Volume Clone

Arguments: src_snapshot_id, name, size_unit, access, attributes, size, src_volume_id, account_id

Create volume clones on Element OS

Na Elementsw Volume Pair *arguments

NetApp Element Software Volume Pair

Arguments: src_account, dest_username, state, dest_volume, dest_mvip, mode, dest_password, dest_account, src_volume

Create, delete volume pair

Na Ontap Aggregate *arguments

NetApp ONTAP manage aggregates.

Arguments: from_name, spare_pool, mirror_disks, raid_type, raid_size, wait_for_online, is_mirrored, disk_type, nodes, unmount_volumes, disk_size, name, disks, disk_count, state, time_out, service_state

Create, delete, or manage aggregates on ONTAP.

Na Ontap Autosupport *arguments

NetApp ONTAP Autosupport

Arguments: mail_hosts, from_address, support, proxy_url, state, node_name, post_url, noteto, to_addresses, hostname_in_subject, partner_addresses, transport

Enable/Disable Autosupport

Na Ontap Broadcast Domain *arguments

NetApp ONTAP manage broadcast domains.

Arguments: state, from_name, name, ipspace, ports, mtu

Modify a ONTAP broadcast domain.

Na Ontap Broadcast Domain Ports *arguments

NetApp ONTAP manage broadcast domain ports

Arguments: broadcast_domain, state, ipspace, ports

Add or remove ONTAP broadcast domain ports. Existing ports that are not listed are kept.

Na Ontap Cg Snapshot *arguments

NetApp ONTAP manage consistency group snapshot

Arguments: vserver, state, snapshot, timeout, volumes, snapmirror_label

Create consistency group snapshot for ONTAP volumes.

Na Ontap Cifs *arguments

NetApp ONTAP Manage cifs-share

Arguments: vserver, vscan_fileop_profile, state, share_name, symlink_properties, path, share_properties

Create or destroy or modify(path) cifs-share on ONTAP

Na Ontap Cifs Acl *arguments

NetApp ONTAP manage cifs-share-access-control

Arguments: vserver, state, permission, user_or_group, share_name

Create or destroy or modify cifs-share-access-controls on ONTAP

Na Ontap Cifs Server *arguments

NetApp ONTAP CIFS server configuration

Arguments: admin_user_name, force, name, domain, vserver, state, admin_password, ou, service_state, workgroup

Creating / deleting and modifying the CIFS server .

Na Ontap Cluster *arguments

NetApp ONTAP cluster - create, join, add license

Arguments: cluster_name, state, node_serial_number, license_code, cluster_ip_address, license_package

Create or join or apply licenses to ONTAP clusters Cluster join can be performed using only one of the parameters, either cluster_name or cluster_ip_address

Na Ontap Cluster Ha *arguments

NetApp ONTAP Manage HA status for cluster

Arguments: state

Enable or disable HA on a cluster

Na Ontap Cluster Peer *arguments

NetApp ONTAP Manage Cluster peering

Arguments: dest_username, dest_intercluster_lifs, dest_hostname, source_cluster_name, state, source_intercluster_lifs, passphrase, dest_password, dest_cluster_name

Create/Delete cluster peer relations on ONTAP

Na Ontap Command *arguments

NetApp ONTAP Run any cli command, the username provided needs to have console login permission.

Arguments: privilege, return_dict, command

Run system-cli commands on ONTAP

Na Ontap Disks *arguments

NetApp ONTAP Assign disks to nodes

Arguments: node, disk_count

Assign all or part of disks to nodes.

Na Ontap Dns *arguments

NetApp ONTAP Create, delete, modify DNS servers.

Arguments: vserver, domains, state, nameservers, skip_validation

Create, delete, modify DNS servers.

Na Ontap Export Policy *arguments

NetApp ONTAP manage export-policy

Arguments: vserver, state, from_name, name

Create or destroy or rename export-policies on ONTAP

Na Ontap Export Policy Rule *arguments

NetApp ONTAP manage export policy rules

Arguments: protocol, name, super_user_security, rw_rule, allow_suid, vserver, ro_rule, state, client_match, rule_index

Create or delete or modify export rules in ONTAP

Na Ontap Fcp *arguments

NetApp ONTAP Start, Stop and Enable FCP services.

Arguments: status, vserver, state

Start, Stop and Enable FCP services.

Na Ontap Firewall Policy *arguments

NetApp ONTAP Manage a firewall policy

Arguments: allow_list, node, enable, logging, service, vserver, state, policy

Configure firewall on an ONTAP node and manage firewall policy for an ONTAP SVM

Na Ontap Firmware Upgrade *arguments

NetApp ONTAP firmware upgrade for SP, shelf, ACP, and disk.

Arguments: node, update_type, shelf_module_fw, package, firmware_type, disk_fw, state, install_baseline_image, clear_logs

Update ONTAP service-prosessor firmware

Na Ontap Flexcache *arguments

NetApp ONTAP FlexCache - create/delete relationship

Arguments: volume, origin_cluster, origin_volume, aggr_list_multiplier, size_unit, origin_vserver, force_unmount, vserver, state, aggr_list, auto_provision_as, time_out, size, force_offline, junction_path

Create/Delete FlexCache volume relationships

Na Ontap Igroup *arguments

NetApp ONTAP iSCSI or FC igroup configuration

Arguments: from_name, name, bind_portset, force_remove_initiator, vserver, ostype, state, initiator_group_type, initiators

Create/Delete/Rename Igroups and Modify initiators belonging to an igroup

Na Ontap Igroup Initiator *arguments

NetApp ONTAP igroup initiator configuration

Arguments: initiator_group, vserver, state, names

Add/Remove initiators from an igroup

Na Ontap Info *arguments

NetApp information gatherer

Arguments: state, gather_subset

This module allows you to gather various information about ONTAP configuration

Na Ontap Interface *arguments

NetApp ONTAP LIF configuration

Arguments: force_subnet_association, failover_policy, netmask, address, home_port, is_auto_revert, protocols, is_dns_update_enabled, firewall_policy, home_node, dns_domain_name, listen_for_dns_query, admin_status, vserver, state, role, subnet_name, interface_name

Creating / deleting and modifying the LIF.

Na Ontap Ipspace *arguments

NetApp ONTAP Manage an ipspace

Arguments: state, from_name, name

Manage an ipspace for an Ontap Cluster

Na Ontap Iscsi *arguments

NetApp ONTAP manage iSCSI service

Arguments: vserver, state, service_state

create, delete, start, stop iSCSI service on SVM.

Na Ontap Job Schedule *arguments

NetApp ONTAP Job Schedule

Arguments: job_hours, state, job_months, name, job_days_of_week, job_minutes, job_days_of_month

Create/Delete/Modify job-schedules on ONTAP

Na Ontap Kerberos Realm *arguments

NetApp ONTAP vserver nfs kerberos realm

Arguments: comment, realm, kdc_vendor, admin_server_ip, vserver, pw_server_port, state, admin_server_port, kdc_port, clock_skew, pw_server_ip, kdc_ip

Create, modify or delete vserver kerberos realm configuration

Na Ontap Ldap *arguments

NetApp ONTAP LDAP

Arguments: vserver, state, name, skip_config_validation

Create, modify or delete LDAP on NetApp ONTAP SVM/vserver

Na Ontap Ldap Client *arguments

NetApp ONTAP LDAP client

Arguments: min_bind_level, referral_enabled, query_timeout, ldap_servers, bind_dn, session_security, vserver, state, use_start_tls, base_scope, bind_password, base_dn, schema, port, name

Create, modify or delete LDAP client on NetApp ONTAP

Na Ontap License *arguments

NetApp ONTAP protocol and feature licenses

Arguments: license_names, state, remove_unused, remove_expired, serial_number, license_codes

Add or remove licenses on NetApp ONTAP.

Na Ontap Lun *arguments

NetApp ONTAP manage LUNs

Arguments: force_remove, name, flexvol_name, state, size_unit, vserver, force_resize, space_reserve, ostype, size, force_remove_fenced, space_allocation

Create, destroy, resize LUNs on NetApp ONTAP.

Na Ontap Lun Copy *arguments

NetApp ONTAP copy LUNs

Arguments: destination_vserver, state, source_path, destination_path, source_vserver

Copy LUNs on NetApp ONTAP.

Na Ontap Lun Map *arguments

NetApp ONTAP LUN maps

Arguments: vserver, path, state, initiator_group_name, lun_id

Map and unmap LUNs on NetApp ONTAP.

Na Ontap Motd *arguments

Setup motd

Arguments: vserver, state, message, show_cluster_motd

This module allows you to manipulate motd for a vserver It also allows to manipulate motd at the cluster level by using the cluster vserver (cserver)

Na Ontap Ndmp *arguments

NetApp ONTAP NDMP services configuration

Arguments: backup_log_enable, secondary_debug_filter, authtype, enable, ignore_ctime_enabled, tcpwinsize, offset_map_enable, preferred_interface_role, fh_dir_retry_interval, debug_filter, dump_logical_find, fh_node_retry_interval, data_port_range, debug_enable, per_qtree_exclude_enable, vserver, abort_on_disk_error, tcpnodelay, restore_vm_cache_size, is_secure_control_connection_enabled, dump_detailed_stats

Modify NDMP Services.

Na Ontap Net Ifgrp *arguments

NetApp Ontap modify network interface group

Arguments: node, state, name, distribution_function, ports, mode

Create, modify ports, destroy the network interface group

Na Ontap Net Port *arguments

NetApp ONTAP network ports.

Arguments: node, duplex_admin, flowcontrol_admin, autonegotiate_admin, ipspace, mtu, state, speed_admin, ports

Modify a ONTAP network port.

Na Ontap Net Routes *arguments

NetApp ONTAP network routes

Arguments: metric, destination, gateway, vserver, state, from_gateway, from_metric, from_destination

Modify ONTAP network routes.

Na Ontap Net Subnet *arguments

NetApp ONTAP Create, delete, modify network subnets.

Arguments: subnet, from_name, name, broadcast_domain, ipspace, ip_ranges, state, gateway

Create, modify, destroy the network subnet

Na Ontap Net Vlan *arguments

NetApp ONTAP network VLAN

Arguments: parent_interface, node, state, vlanid

Create or Delete a network VLAN

Na Ontap Nfs *arguments

NetApp ONTAP NFS status

Arguments: udp, nfsv4, tcp, nfsv3, nfsv41, nfsv40_write_delegation, nfsv41_referrals, nfsv4_numeric_ids, nfsv41_pnfs, nfsv41_write_delegation, nfsv3_fsid_change, nfsv4_fsid_change, nfsv41_acl, tcp_max_xfer_size, nfsv41_read_delegation, nfsv40_acl, vserver, vstorage_state, state, showmount, nfsv4_id_domain, nfsv40_referrals, nfsv40_read_delegation, service_state

Enable or disable NFS on ONTAP

Na Ontap Node *arguments

NetApp ONTAP Rename a node.

Arguments: from_name, name

Rename an ONTAP node.

Na Ontap Ntp *arguments

NetApp ONTAP NTP server

Arguments: state, version, server_name

Create or delete or modify NTP server in ONTAP

Na Ontap Nvme *arguments

NetApp ONTAP Manage NVMe Service

Arguments: vserver, state, status_admin

Create/Delete NVMe Service

Na Ontap Nvme Namespace *arguments

NetApp ONTAP Manage NVME Namespace

Arguments: vserver, ostype, state, size, path

Create/Delete NVME namespace

Na Ontap Nvme Subsystem *arguments

NetApp ONTAP Manage NVME Subsystem

Arguments: subsystem, paths, vserver, state, skip_host_check, ostype, hosts, skip_mapped_check

Create/Delete NVME subsystem Associate(modify) host/map to NVME subsystem NVMe service should be existing in the data vserver with NVMe protocol as a pre-requisite

Na Ontap Object Store *arguments

NetApp ONTAP manage object store config.

Arguments: access_key, state, secret_password, container, name, provider_type, server

Create or delete object store config on ONTAP.

Na Ontap Ports *arguments

NetApp ONTAP add/remove ports

Arguments: vserver, state, resource_name, names, portset_type, ipspace, resource_type

Add or remove ports for broadcast domain and portset.

Na Ontap Portset *arguments

NetApp ONTAP Create/Delete portset

Arguments: vserver, state, force, name, type, ports

Create/Delete ONTAP portset, modify ports in a portset.

Na Ontap Qos Adaptive Policy Group *arguments

NetApp ONTAP Adaptive Quality of Service policy group.

Arguments: peak_iops, from_name, peak_iops_allocation, name, absolute_min_iops, vserver, state, expected_iops, force

Create, destroy, modify, or rename an Adaptive QoS policy group on NetApp ONTAP. Module is based on the standard QoS policy group module.

Na Ontap Qos Policy Group *arguments

NetApp ONTAP manage policy group in Quality of Service.

Arguments: vserver, state, from_name, force, name, min_throughput, max_throughput

Create, destroy, modify, or rename QoS policy group on NetApp ONTAP.

Na Ontap Qtree *arguments

NetApp ONTAP manage qtrees

Arguments: export_policy, from_name, name, flexvol_name, unix_permissions, vserver, state, oplocks, security_style

Create or destroy Qtrees.

Na Ontap Quotas *arguments

NetApp ONTAP Quotas

Arguments: qtree, vserver, quota_target, file_limit, set_quota_status, disk_limit, volume, policy, state, threshold, type

Set/Modify/Delete quota on ONTAP

Na Ontap Security Key Manager *arguments

NetApp ONTAP security key manager.

Arguments: node, tcp_port, state, ip_address

Add or delete or setup key management on NetApp ONTAP.

Na Ontap Service Processor Network *arguments

NetApp ONTAP service processor network

Arguments: is_enabled, node, address_type, state, netmask, prefix_length, dhcp, wait_for_completion, ip_address, gateway_ip_address

Modify a ONTAP service processor network

Na Ontap Snapmirror *arguments

NetApp ONTAP or ElementSW Manage SnapMirror

Arguments: destination_vserver, schedule, destination_path, source_password, relationship_type, max_transfer_rate, connection_type, source_username, identity_preserve, source_path, source_volume, source_vserver, state, source_hostname, policy, destination_volume

Create/Delete/Initialize SnapMirror volume/vserver relationships for ONTAP/ONTAP Create/Delete/Initialize SnapMirror volume relationship between ElementSW and ONTAP Modify schedule for a SnapMirror relationship for ONTAP/ONTAP and ElementSW/ONTAP Pre-requisite for ElementSW to ONTAP relationship or vice-versa is an established SnapMirror endpoint for ONTAP cluster with ElementSW UI Pre-requisite for ElementSW to ONTAP relationship or vice-versa is to have SnapMirror enabled in the ElementSW volume For creating a SnapMirror ElementSW/ONTAP relationship, an existing ONTAP/ElementSW relationship should be present

Na Ontap Snapshot *arguments

NetApp ONTAP manage Snapshots

Arguments: comment, volume, from_name, snapshot_instance_uuid, ignore_owners, state, vserver, async_bool, snapmirror_label, snapshot

Create/Modify/Delete ONTAP snapshots

Na Ontap Snapshot Policy *arguments

NetApp ONTAP manage Snapshot Policy

Arguments: comment, count, name, schedule, enabled, state, vserver, snapmirror_label

Create/Modify/Delete ONTAP snapshot policies

Na Ontap Snmp *arguments

NetApp ONTAP SNMP community

Arguments: community_name, state, access_control

Create/Delete SNMP community

Na Ontap Software Update *arguments

NetApp ONTAP Update Software

Arguments: package_url, state, ignore_validation_warning, nodes, package_version

Update ONTAP software Requires an https connection and is not supported over http

Na Ontap Svm *arguments

NetApp ONTAP SVM

Arguments: comment, from_name, root_volume_aggregate, name, language, ipspace, root_volume_security_style, allowed_protocols, subtype, state, aggr_list, snapshot_policy, root_volume

Create, modify or delete SVM on NetApp ONTAP

Na Ontap Svm Options *arguments

NetApp ONTAP Modify SVM Options

Arguments: vserver, name, value

Modify ONTAP SVM Options Only Options that appear on "vserver options show" can be set

Na Ontap Ucadapter *arguments

NetApp ONTAP UC adapter configuration

Arguments: state, node_name, type, mode, adapter_name

modify the UC adapter mode and type taking pending type and mode into account.

Na Ontap Unix Group *arguments

NetApp ONTAP UNIX Group

Arguments: vserver, skip_name_validation, state, name, id, users

Create/Delete Unix user group

Na Ontap Unix User *arguments

NetApp ONTAP UNIX users

Arguments: vserver, state, name, full_name, group_id, id

Create, delete or modify UNIX users local to ONTAP.

Na Ontap User *arguments

NetApp ONTAP user configuration and management

Arguments: lock_user, name, authentication_method, vserver, applications, state, role_name, set_password

Create or destroy users.

Na Ontap User Role *arguments

NetApp ONTAP user role configuration and management

Arguments: vserver, access_level, state, name, query, command_directory_name

Create or destroy user roles

Na Ontap Volume *arguments

NetApp ONTAP manage volumes.

Arguments: comment, space_slo, unix_permissions, size, aggr_list, encrypt, tiering_policy, snapdir_access, size_unit, vserver, state, vserver_dr_protection, policy, auto_provision_as, aggregate_name, aggr_list_multiplier, from_name, is_infinite, atime_update, qos_adaptive_policy_group, junction_path, is_online, nvfail_enabled, wait_for_completion, name, volume_security_style, efficiency_policy, language, type, percent_snapshot_space, space_guarantee, snapshot_policy, time_out, qos_policy_group

Create or destroy or modify volumes on NetApp ONTAP.

Na Ontap Volume Autosize *arguments

NetApp ONTAP manage volume autosize

Arguments: reset, volume, increment_size, minimum_size, shrink_threshold_percent, vserver, mode, maximum_size, grow_threshold_percent

Modify Volume AutoSize

Na Ontap Volume Clone *arguments

NetApp ONTAP manage volume clones.

Arguments: parent_volume, name, parent_snapshot, state, volume_type, vserver, space_reserve, junction_path, gid, qos_policy_group_name, parent_vserver, uid

Create NetApp ONTAP volume clones. A FlexClone License is required to use this module

Na Ontap Vscan *arguments

NetApp ONTAP Vscan enable/disable.

Arguments: vserver, enable

Enable and Disable Vscan

Na Ontap Vscan On Access Policy *arguments

NetApp ONTAP Vscan on access policy configuration.

Arguments: max_file_size, vserver, filters, is_scan_mandatory, scan_files_with_no_ext, policy_name, file_ext_to_include, state, paths_to_exclude, file_ext_to_exclude

Configure on access policy for Vscan (virus scan)

Na Ontap Vscan On Demand Task *arguments

NetApp ONTAP Vscan on demand task configuration.

Arguments: request_timeout, schedule, scan_files_with_no_ext, scan_priority, state, file_ext_to_exclude, directory_recursion, max_file_size, cross_junction, vserver, scan_paths, report_directory, file_ext_to_include, report_log_level, paths_to_exclude, task_name

Configure on demand task for Vscan

Na Ontap Vscan Scanner Pool *arguments

NetApp ONTAP Vscan Scanner Pools Configuration.

Arguments: vserver, scanner_policy, privileged_users, hostnames, state, scanner_pool

Configure a Vscan Scanner Pool

Na Ontap Vserver Cifs Security *arguments

NetApp ONTAP vserver CIFS security modification

Arguments: session_security_for_ad_ldap, kerberos_renew_age, use_start_tls_for_ad_ldap, is_password_complexity_required, smb1_enabled_for_dc_connections, is_signing_required, kerberos_clock_skew, kerberos_ticket_age, is_aes_encryption_enabled, vserver, kerberos_kdc_timeout, is_smb_encryption_required, referral_enabled_for_ad_ldap, smb2_enabled_for_dc_connections, lm_compatibility_level

modify vserver CIFS security.

Na Ontap Vserver Peer *arguments

NetApp ONTAP Vserver peering

Arguments: dest_username, dest_hostname, vserver, applications, state, peer_cluster, dest_password, peer_vserver

Create/Delete vserver peer

Nagios *arguments

Perform common tasks in Nagios related to downtime and notifications.

Arguments: comment, servicegroup, author, action, host, command, services, minutes, cmdfile

The C(nagios) module has two basic functions: scheduling downtime and toggling alerts for services or hosts. All actions require the I(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer to the host the playbook is currently running on. You can specify multiple services at once by separating them with commas, .e.g., C(services=httpd,nfs,puppet). When specifying what service to handle there is a special service value, I(host), which will handle alerts/downtime for the I(host itself), e.g., C(service=host). This keyword may not be given with other services at the same time. I(Setting alerts/downtime for a host does not affect alerts/downtime for any of the services running on it.) To schedule downtime for all services on particular host use keyword "all", e.g., C(service=all). When using the C(nagios) module you will need to specify your Nagios server using the C(delegate_to) parameter.

Nclu *arguments

Configure network interfaces using NCLU

Arguments: commands, abort, description, template, commit, atomic

Interface to the Network Command Line Utility, developed to make it easier to configure operating systems running ifupdown2 and Quagga, such as Cumulus Linux. Command documentation is available at U(https://docs.cumulusnetworks.com/cumulus-linux/System-Configuration/Network-Command-Line-Utility-NCLU/)

Net Get *arguments

Copy a file from a network device to Ansible Controller

Arguments: dest, src, protocol

This module provides functionality to copy file from network device to ansible controller.

Net Ping *arguments

Tests reachability using ping from a network device

Arguments: count, dest, state, vrf, source

Tests reachability using ping from network device to a remote destination. For Windows targets, use the M(win_ping) module instead. For targets running Python, use the M(ping) module instead.

Net Put *arguments

Copy a file from Ansible Controller to a network device

Arguments: dest, src, protocol, mode

This module provides functionality to copy file from Ansible controller to network devices.

Netact Cm Command *arguments

Manage network configuration data in Nokia Core and Radio networks

Arguments: DN, planName, verbose, opsName, fileName, typeOption, WS, MR, extra_opts, operation, createBackupPlan, backupPlanName, fileFormat, inputFile

netact_cm_command can be used to run various configuration management operations. This module requires that the target hosts have Nokia NetAct network management system installed. Module will access the Configurator command line interface in NetAct to upload network configuration to NetAct, run configuration export, plan import and configuration provision operations To set the scope of the operation, define Distinguished Name (DN) or Working Set (WS) or Maintenance Region (MR) as input

Netapp E Alerts *arguments

NetApp E-Series manage email notification settings

Arguments: test, state, contact, sender, recipients, log_path, server

Certain E-Series systems have the capability to send email notifications on potentially critical events. This module will allow the owner of the system to specify email recipients for these messages.

Netapp E Amg *arguments

NetApp E-Series create, remove, and update asynchronous mirror groups

Arguments: name, syncIntervalMinutes, recoveryWarnThresholdMinutes, secondaryArrayId, repoUtilizationWarnThreshold, state, interfaceType, manualSync, syncWarnThresholdMinutes

Allows for the creation, removal and updating of Asynchronous Mirror Groups for NetApp E-series storage arrays

Netapp E Amg Role *arguments

NetApp E-Series update the role of a storage array within an Asynchronous Mirror Group (AMG).

Arguments: force, ssid, api_password, role, api_username, validate_certs, noSync, api_url

Update a storage array to become the primary or secondary instance in an asynchronous mirror group

Netapp E Amg Sync *arguments

NetApp E-Series conduct synchronization actions on asynchronous mirror groups.

Arguments: ssid, api_password, state, api_username, api_url, delete_recovery_point, validate_certs, name

Allows for the initialization, suspension and resumption of an asynchronous mirror group's synchronization for NetApp E-series storage arrays.

Netapp E Asup *arguments

NetApp E-Series manage auto-support settings

Arguments: start, state, end, verbose, log_path, active, days

Allow the auto-support settings to be configured for an individual E-Series storage-system

Netapp E Auditlog *arguments

NetApp E-Series manage audit-log configuration

Arguments: threshold, force, log_path, log_level, max_records, full_policy

This module allows an e-series storage system owner to set audit-log configuration parameters.

Netapp E Auth *arguments

NetApp E-Series set or update the password for a storage array.

Arguments: ssid, name, new_password, api_password, current_password, api_username, validate_certs, set_admin, api_url

Sets or updates the password for a storage array. When the password is updated on the storage array, it must be updated on the SANtricity Web Services proxy. Note, all storage arrays do not have a Monitor or RO role.

Netapp E Drive Firmware *arguments

NetApp E-Series manage drive firmware

Arguments: upgrade_drives_online, ignore_inaccessible_drives, firmware, wait_for_completion

Ensure drive firmware version is activated on specified drive model.

Netapp E Facts *arguments

NetApp E-Series retrieve facts about NetApp E-Series storage arrays

Arguments:

The netapp_e_facts module returns a collection of facts regarding NetApp E-Series storage arrays. When contacting a storage array directly the collection includes details about the array, controllers, management interfaces, hostside interfaces, driveside interfaces, disks, storage pools, volumes, snapshots, and features. When contacting a web services proxy the collection will include basic information regarding the storage systems that are under its management.

Netapp E Firmware *arguments

NetApp E-Series manage firmware.

Arguments: firmware, ignore_health_check, wait_for_completion, nvsram

Ensure specific firmware versions are activated on E-Series storage system.

Netapp E Flashcache *arguments

NetApp E-Series manage SSD caches

Arguments: cache_size_min, ssid, api_password, io_type, disk_count, size_unit, state, api_username, api_url, validate_certs, name

Create or remove SSD caches on a NetApp E-Series storage array.

Netapp E Global *arguments

NetApp E-Series manage global settings configuration

Arguments: log_path, name

Allow the user to configure several of the global settings associated with an E-Series storage-system

Netapp E Host *arguments

NetApp E-Series manage eseries hosts

Arguments: state, group, name, log_path, host_type, ports, force_port

Create, update, remove hosts on NetApp E-series storage arrays

Netapp E Hostgroup *arguments

NetApp E-Series manage array host groups

Arguments: new_name, state, hosts, name, id

Create, update or destroy host groups on a NetApp E-Series storage array.

Netapp E Iscsi Interface *arguments

NetApp E-Series manage iSCSI interface configuration

Arguments: name, log_path, config_method, controller, mtu, subnet_mask, state, address, gateway

Configure settings of an E-Series iSCSI interface

Netapp E Iscsi Target *arguments

NetApp E-Series manage iSCSI target configuration

Arguments: log_path, unnamed_discovery, ping, name, chap_secret

Configure the settings of an E-Series iSCSI target

Netapp E Ldap *arguments

NetApp E-Series manage LDAP integration to use for authentication

Arguments: username, user_attribute, password, name, search_base, log_path, server, state, role_mappings, attributes, identifier

Configure an E-Series system to allow authentication via an LDAP server

Netapp E Lun Mapping *arguments

NetApp E-Series create, delete, or modify lun mappings

Arguments: state, volume_name, target_type, lun, target

Create, delete, or modify mappings between a volume and a targeted host/host+ group.

Netapp E Mgmt Interface *arguments

NetApp E-Series management interface configuration

Arguments: log_path, ntp_config_method, ntp_address, subnet_mask, controller, ssh, address, dns_address, gateway, name, ntp_address_backup, config_method, dns_address_backup, state, dns_config_method, channel

Configure the E-Series management interfaces

Netapp E Snapshot Group *arguments

NetApp E-Series manage snapshot groups

Arguments: repo_pct, warning_threshold, rollback_priority, delete_limit, api_password, name, state, storage_pool_name, api_username, base_volume_name, full_policy, validate_certs, api_url

Create, update, delete snapshot groups for NetApp E-series storage arrays

Netapp E Snapshot Images *arguments

NetApp E-Series create and delete snapshot images

Arguments: state, api_url, snapshot_group, api_username, validate_certs, api_password

Create and delete snapshots images on snapshot groups for NetApp E-series storage arrays. Only the oldest snapshot image can be deleted so consistency is preserved. Related: Snapshot volumes are created from snapshot images.

Netapp E Snapshot Volume *arguments

NetApp E-Series manage snapshot volumes.

Arguments: snapshot_image_id, ssid, api_password, repo_percentage, full_threshold, view_mode, state, storage_pool_name, api_username, api_url, validate_certs, name

Create, update, remove snapshot volumes for NetApp E/EF-Series storage arrays.

Netapp E Storage System *arguments

NetApp E-Series Web Services Proxy manage storage arrays

Arguments: meta_tags, ssid, array_wwn, api_password, api_username, state, array_password, api_url, enable_trace, validate_certs, controller_addresses

Manage the arrays accessible via a NetApp Web Services Proxy for NetApp E-series storage arrays.

Netapp E Storagepool *arguments

NetApp E-Series manage volume groups and disk pools

Arguments: criteria_size_unit, criteria_drive_require_fde, criteria_min_usable_capacity, name, reserve_drive_count, secure_pool, raid_level, criteria_drive_type, state, remove_volumes, criteria_drive_min_size, criteria_drive_count, criteria_drive_require_da, erase_secured_drives, criteria_drive_interface_type

Create or remove volume groups and disk pools for NetApp E-series storage arrays.

Netapp E Syslog *arguments

NetApp E-Series manage syslog settings

Arguments: test, state, protocol, components, address, log_path, port

Allow the syslog settings to be configured for an individual E-Series storage-system

Netapp E Volume *arguments

NetApp E-Series manage storage volumes (standard and thin)

Arguments: segment_size_kb, read_cache_enable, thin_provision, initialization_timeout, data_assurance_enabled, thin_volume_growth_alert_threshold, write_cache_enable, thin_volume_expansion_policy, size, read_ahead_enable, ssd_cache_enabled, name, workload_name, size_unit, cache_without_batteries, state, storage_pool_name, wait_for_initialization, owning_controller, metadata, thin_volume_repo_size, thin_volume_max_repo_size

Create or remove volumes (standard and thin) for NetApp E/EF-series storage arrays.

Netapp E Volume Copy *arguments

NetApp E-Series create volume copy pairs

Arguments: create_copy_pair_if_does_not_exist, search_volume_id, api_url, source_volume_id, api_password, destination_volume_id, volume_copy_pair_id, state, api_username, start_stop_copy, validate_certs

Create and delete snapshots images on volume groups for NetApp E-series storage arrays.

Netbox Device *arguments

Create, update or delete devices within Netbox

Arguments: netbox_url, state, data, netbox_token, validate_certs

Creates, updates or removes devices from Netbox

Netbox Interface *arguments

Creates or removes interfaces from Netbox

Arguments: netbox_url, state, data, netbox_token, validate_certs

Creates or removes interfaces from Netbox

Netbox Ip Address *arguments

Creates or removes IP addresses from Netbox

Arguments: netbox_url, state, data, netbox_token, validate_certs

Creates or removes IP addresses from Netbox

Netbox Prefix *arguments

Creates or removes prefixes from Netbox

Arguments: first_available, state, netbox_url, netbox_token, validate_certs, data

Creates or removes prefixes from Netbox

Netbox Site *arguments

Creates or removes sites from Netbox

Arguments: netbox_url, state, data, netbox_token, validate_certs

Creates or removes sites from Netbox

Netconf Config *arguments

netconf device configuration

Arguments: backup_options, format, lock, source_datastore, validate, src, target, confirm, error_option, content, confirm_commit, default_operation, commit, save, backup, delete

Netconf is a network management protocol developed and standardized by the IETF. It is documented in RFC 6241. This module allows the user to send a configuration XML file to a netconf device, and detects if there was a configuration change.

Netconf Get *arguments

Fetch configuration/state data from NETCONF enabled network devices.

Arguments: filter, source, display, lock

NETCONF is a network management protocol developed and standardized by the IETF. It is documented in RFC 6241. This module allows the user to fetch configuration and state data from NETCONF enabled network devices.

Netconf Rpc *arguments

Execute operations on NETCONF enabled network devices.

Arguments: content, rpc, xmlns, display

NETCONF is a network management protocol developed and standardized by the IETF. It is documented in RFC 6241. This module allows the user to execute NETCONF RPC requests as defined by IETF RFC standards as well as proprietary requests.

Netcup Dns *arguments

manage Netcup DNS records

Arguments: solo, domain, api_key, api_password, value, priority, record, state, customer_id, type

Manages DNS records via the Netcup API, see the docs U(https://ccp.netcup.net/run/webservice/servers/endpoint.php)

Netscaler Cs Action *arguments

Manage content switching actions

Arguments: comment, targetvserver, name, targetvserverexpr, targetlbvserver

Manage content switching actions This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance

Netscaler Cs Policy *arguments

Manage content switching policy

Arguments: url, policyname, domain, action, rule

Manage content switching policy. This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.

Netscaler Cs Vserver *arguments

Manage content switching vserver

Arguments: comment, oracleserverversion, precedence, domainname, backupvserver, rtspnat, backupip, disabled, mysqlprotocolversion, listenpolicy, ssl_certkey, icmpvsrresponse, ttl, redirecturl, ipmask, authnprofile, redirectportrewrite, port, clttimeout, authenticationhost, servicetype, insertvserveripport, sopersistence, mysqlservercapabilities, mysqlserverversion, mysqlcharacterset, authn401, vipheader, pushvserver, authentication, authnvsname, netprofile, pushmulticlients, td, mssqlserverversion, lbvserver, httpprofilename, rhistate, targettype, sothreshold, cookietimeout, appflowlog, sobackupaction, dbprofilename, cookiedomain, cacheable, l2conn, ipv46, name, ippattern, disableprimaryondown, tcpprofilename, downstateflush, sitedomainttl, pushlabel, sopersistencetimeout, casesensitive, range, somethod, push, stateupdate, dnsprofilename

Manage content switching vserver This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance

Netscaler Gslb Service *arguments

Manage gslb service entities in Netscaler.

Arguments: comment, cnameentry, appflowlog, servername, hashid, servicename, sitepersistence, monitor_bindings, maxbandwidth, publicport, port, clttimeout, servicetype, monthreshold, maxaaausers, maxclient, sitename, ipaddress, downstateflush, cipheader, siteprefix, publicip, cip, healthmonitor

Manage gslb service entities in Netscaler.

Netscaler Gslb Site *arguments

Manage gslb site entities in Netscaler.

Arguments: publicip, siteipaddress, metricexchange, nwmetricexchange, sitename, sitetype, sessionexchange, publicclip, naptrreplacementsuffix, parentsite, clip, triggermonitor

Manage gslb site entities in Netscaler.

Netscaler Gslb Vserver *arguments

Configure gslb vserver entities in Netscaler.

Arguments: comment, sothreshold, sopersistence, appflowlog, persistenceid, sobackupaction, domain_bindings, dnsrecordtype, disabled, considereffectivestate, netmask, v6netmasklen, servicetype, persistencetype, name, disableprimaryondown, backuplbmethod, dynamicweight, somethod, service_bindings, sopersistencetimeout, persistmask, timeout, v6persistmasklen, mir, tolerance, lbmethod

Configure gslb vserver entities in Netscaler.

Netscaler Lb Monitor *arguments

Manage load balancing monitors

Arguments: lasversion, secure, radnasip, Snmpoid, storefrontacctservice, radnasid, firmwarerevision, ipaddress, query, storedb, vendorid, authapplicationid, group, tos, maxforwards, send, sipreguri, rtsprequest, trofscode, successretries, iptunnel, monitorname, units1, units3, units2, units4, scriptargs, destport, resptimeout, downtime, password, transparent, retries, failureretries, snmpthreshold, radkey, type, database, snmpcommunity, validatecred, productname, username, metrictable, dispatcherport, acctapplicationid, oraclesid, radaccounttype, binddn, domain, vendorspecificacctapplicationids, resptimeoutthresh, hostipaddress, sipuri, attribute, vendorspecificvendorid, destip, scriptname, originrealm, dispatcherip, radmsisdn, secondarypassword, respcode, trofsstring, logonpointname, kcdaccount, radapn, hostname, radframedip, filename, application, state, netprofile, alertretries, radaccountsession, deviation, httprequest, supportedvendorids, inbandsecurityid, basedn, sitepath, storefrontcheckbackendservices, interval, sqlquery, evalrule, sipmethod, customheaders, mssqlprotocolversion, recv, querytype, tosid, reverse, storename, lrtm, originhost, filter, vendorspecificauthapplicationids, snmpversion, action

Manage load balancing monitors. This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.

Netscaler Lb Vserver *arguments

Manage load balancing vserver configuration

Arguments: servicebindings, comment, rtspnat, disabled, macmoderetainvlan, dbslb, listenpolicy, disableprimaryondown, ipmask, insertvserveripport, redirectportrewrite, clttimeout, authenticationhost, servicetype, mysqlservercapabilities, vipheader, pushvserver, dataoffset, datalength, rhistate, td, httpprofilename, newservicerequestincrementinterval, appflowlog, dbprofilename, netmask, processlocal, minautoscalemembers, name, backuplbmethod, downstateflush, pushlabel, persistmask, timeout, v6persistmasklen, persistavpno, recursionavailable, dnsprofilename, maxautoscalemembers, oracleserverversion, m, bypassaaaa, somethod, mysqlprotocolversion, icmpvsrresponse, authnprofile, port, servicegroupbindings, ssl_certkey, persistencebackup, mysqlserverversion, mysqlcharacterset, authn401, authentication, authnvsname, healththreshold, netprofile, pushmulticlients, mssqlserverversion, lbmethod, hashlength, resrule, connfailover, sothreshold, sopersistence, dns64, sobackupaction, skippersistency, cacheable, l2conn, v6netmasklen, sessionless, ipv46, persistencetype, tosid, ippattern, tcpprofilename, backuppersistencetimeout, newservicerequestunit, redirurl, cookiename, listenpriority, sopersistencetimeout, range, newservicerequest, push

Manage load balancing vserver configuration This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance

Netscaler Nitro Request *arguments

Issue Nitro API requests to a Netscaler instance.

Arguments: instance_name, args, expected_nitro_errorcode, resource, operation, filter, instance_ip, name, nitro_protocol, instance_id, nsip, nitro_user, action, attributes, nitro_pass, validate_certs, nitro_auth_token

Issue Nitro API requests to a Netscaler instance. This is intended to be a short hand for using the uri Ansible module to issue the raw HTTP requests directly. It provides consistent return values and has no other dependencies apart from the base Ansible runtime environment. This module is intended to run either on the Ansible control node or a bastion (jumpserver) with access to the actual Netscaler instance

Netscaler Save Config *arguments

Save Netscaler configuration.

Arguments: nitro_protocol, nsip, nitro_user, nitro_pass, validate_certs, nitro_timeout

This module unconditionally saves the configuration on the target netscaler node. This module does not support check mode. This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.

Netscaler Server *arguments

Manage server configuration

Arguments: comment, delay, domain, name, ipv6address, domainresolveretry, translationmask, disabled, translationip, graceful, td, ipaddress

Manage server entities configuration. This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.

Netscaler Service *arguments

Manage service configuration in Netscaler

Arguments: comment, tcpb, cachetype, ip, servername, disabled, maxreq, monitor_bindings, maxbandwidth, svrtimeout, port, clttimeout, servicetype, cacheable, cleartextport, maxclient, processlocal, graceful, usip, netprofile, customserverid, td, httpprofilename, pathmonitorindv, pathmonitor, appflowlog, rtspsessionidremap, monthreshold, hashid, serverid, ipaddress, accessdown, name, tcpprofilename, sp, downstateflush, cipheader, cip, healthmonitor, useproxyport, cka, cmp, dnsprofilename

Manage service configuration in Netscaler. This module allows the creation, deletion and modification of Netscaler services. This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance. This module supports check mode.

Netscaler Servicegroup *arguments

Manage service group configuration in Netscaler

Arguments: comment, tcpb, cachetype, disabled, maxreq, maxbandwidth, graceful, svrtimeout, clttimeout, servicetype, cacheable, autoscale, maxclient, monitorbindings, servicegroupname, usip, netprofile, rtspsessionidremap, httpprofilename, pathmonitorindv, pathmonitor, appflowlog, servicemembers, monthreshold, memberport, cka, tcpprofilename, sp, downstateflush, cipheader, cip, healthmonitor, useproxyport, cmp

Manage service group configuration in Netscaler. This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.

Netscaler Ssl Certkey *arguments

Manage ssl certificate keys.

Arguments: certkey, passplain, inform, cert, key, notificationperiod, expirymonitor, password

Manage ssl certificate keys.

Newrelic Deployment *arguments

Notify newrelic about app deployments

Arguments: application_id, description, changelog, appname, environment, token, user, revision, validate_certs, app_name

Notify newrelic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/deployment-notifications#api)

Nexmo *arguments

Send a SMS via nexmo

Arguments: src, dest, api_secret, api_key, validate_certs, msg

Send a SMS message via nexmo

Nginx Status Info *arguments

Retrieve information on nginx status.

Arguments: url, timeout

Gathers information from nginx from an URL having C(stub_status) enabled.

Nictagadm *arguments

Manage nic tags on SmartOS systems

Arguments: mac, force, name, state, etherstub, mtu

Create or delete nic tags on SmartOS systems.

Nios A Record *arguments

Configure Infoblox NIOS A records

Arguments: comment, state, name, ttl, extattrs, ipv4addr, view

Adds and/or removes instances of A record objects from Infoblox NIOS servers. This module manages NIOS C(record:a) objects using the Infoblox WAPI interface over REST.

Nios Aaaa Record *arguments

Configure Infoblox NIOS AAAA records

Arguments: comment, state, name, ttl, ipv6addr, extattrs, view

Adds and/or removes instances of AAAA record objects from Infoblox NIOS servers. This module manages NIOS C(record:aaaa) objects using the Infoblox WAPI interface over REST.

Nios Cname Record *arguments

Configure Infoblox NIOS CNAME records

Arguments: comment, state, name, extattrs, ttl, canonical, view

Adds and/or removes instances of CNAME record objects from Infoblox NIOS servers. This module manages NIOS C(record:cname) objects using the Infoblox WAPI interface over REST.

Nios Dns View *arguments

Configure Infoblox NIOS DNS views

Arguments: comment, state, name, network_view, extattrs

Adds and/or removes instances of DNS view objects from Infoblox NIOS servers. This module manages NIOS C(view) objects using the Infoblox WAPI interface over REST. Updates instances of DNS view object from Infoblox NIOS servers.

Nios Fixed Address *arguments

Configure Infoblox NIOS DHCP Fixed Address

Arguments: comment, name, network_view, ipaddr, mac, state, extattrs, options, network

A fixed address is a specific IP address that a DHCP server always assigns when a lease request comes from a particular MAC address of the client. Supports both IPV4 and IPV6 internet protocols

Nios Host Record *arguments

Configure Infoblox NIOS host records

Arguments: comment, name, ttl, ipv6addrs, configure_for_dns, state, ipv4addrs, extattrs, aliases, view

Adds and/or removes instances of host record objects from Infoblox NIOS servers. This module manages NIOS C(record:host) objects using the Infoblox WAPI interface over REST. Updates instances of host record object from Infoblox NIOS servers.

Nios Member *arguments

Configure Infoblox NIOS members

Arguments: comment, router_id, syslog_servers, lan2_port_setting, extattrs, upgrade_group, create_token, node_info, use_syslog_proxy_setting, enable_ha, vip_setting, config_addr_type, external_syslog_server_enable, platform, state, host_name, ipv6_setting, mgmt_port_setting, pre_provisioning, lan2_enabled

Adds and/or removes Infoblox NIOS servers. This module manages NIOS C(member) objects using the Infoblox WAPI interface over REST.

Nios Mx Record *arguments

Configure Infoblox NIOS MX records

Arguments: comment, name, mail_exchanger, ttl, state, preference, extattrs, view

Adds and/or removes instances of MX record objects from Infoblox NIOS servers. This module manages NIOS C(record:mx) objects using the Infoblox WAPI interface over REST.

Nios Naptr Record *arguments

Configure Infoblox NIOS NAPTR records

Arguments: comment, name, ttl, state, flags, preference, extattrs, services, regexp, replacement, order, view

Adds and/or removes instances of NAPTR record objects from Infoblox NIOS servers. This module manages NIOS C(record:naptr) objects using the Infoblox WAPI interface over REST.

Nios Network *arguments

Configure Infoblox NIOS network object

Arguments: comment, state, container, network, network_view, extattrs, options

Adds and/or removes instances of network objects from Infoblox NIOS servers. This module manages NIOS C(network) objects using the Infoblox WAPI interface over REST. Supports both IPV4 and IPV6 internet protocols

Nios Network View *arguments

Configure Infoblox NIOS network views

Arguments: comment, state, name, extattrs

Adds and/or removes instances of network view objects from Infoblox NIOS servers. This module manages NIOS C(networkview) objects using the Infoblox WAPI interface over REST. Updates instances of network view object from Infoblox NIOS servers.

Nios Nsgroup *arguments

Configure InfoBlox DNS Nameserver Groups

Arguments: comment, use_external_primary, name, grid_primary, external_primaries, external_secondaries, grid_secondaries, is_grid_default, state, extattrs

Adds and/or removes nameserver groups form Infoblox NIOS servers. This module manages NIOS C(nsgroup) objects using the Infoblox. WAPI interface over REST.

Nios Ptr Record *arguments

Configure Infoblox NIOS PTR records

Arguments: comment, ptrdname, name, ttl, ipv4addr, state, extattrs, ipv6addr, view

Adds and/or removes instances of PTR record objects from Infoblox NIOS servers. This module manages NIOS C(record:ptr) objects using the Infoblox WAPI interface over REST.

Nios Srv Record *arguments

Configure Infoblox NIOS SRV records

Arguments: comment, target, weight, ttl, name, priority, state, extattrs, port, view

Adds and/or removes instances of SRV record objects from Infoblox NIOS servers. This module manages NIOS C(record:srv) objects using the Infoblox WAPI interface over REST.

Nios Txt Record *arguments

Configure Infoblox NIOS txt records

Arguments: comment, state, name, extattrs, text, ttl, view

Adds and/or removes instances of txt record objects from Infoblox NIOS servers. This module manages NIOS C(record:txt) objects using the Infoblox WAPI interface over REST.

Nios Zone *arguments

Configure Infoblox NIOS DNS zones

Arguments: comment, grid_primary, restart_if_needed, zone_format, ns_group, fqdn, state, extattrs, grid_secondaries, view

Adds and/or removes instances of DNS zone objects from Infoblox NIOS servers. This module manages NIOS C(zone_auth) objects using the Infoblox WAPI interface over REST.

Nitz
Nitz 2 **e
Nmcli *arguments

Manage Networking

Arguments: conn_name, ingress, ip_tunnel_local, slavepriority, vxlan_id, path_cost, vlandev, forwarddelay, primary, hairpin, egress, ageingtime, dns4, vxlan_remote, dns4_search, arp_ip_target, dhcp_client_id, maxage, vlanid, priority, gw4, state, gw6, master, stp, ifname, type, miimon, hellotime, ip_tunnel_remote, downdelay, mac, ip6, ip_tunnel_dev, ip4, vxlan_local, autoconnect, dns6_search, dns6, mtu, arp_interval, flags, mode, updelay

Manage the network devices. Create, modify and manage various connection and device type e.g., ethernet, teams, bonds, vlans etc. On CentOS 8 and Fedora >=29 like systems, the requirements can be met by installing the following packages: NetworkManager-nmlib, libsemanage-python, policycoreutils-python. On CentOS 7 and Fedora <=28 like systems, the requirements can be met by installing the following packages: NetworkManager-glib, libnm-qt-devel.x86_64, nm-connection-editor.x86_64, libsemanage-python, policycoreutils-python. On Ubuntu and Debian like systems, the requirements can be met by installing the following packages: network-manager, python-dbus (or python3-dbus, depending on the Python version in use), libnm-dev. On older Ubuntu and Debian like systems, the requirements can be met by installing the following packages: network-manager, python-dbus (or python3-dbus, depending on the Python version in use), libnm-glib-dev. On openSUSE, the requirements can be met by installing the following packages: NetworkManager, python2-dbus-python (or python3-dbus-python), typelib-1_0-NMClient-1_0 and typelib-1_0-NetworkManager-1_0.

Nos Command *arguments

Run commands on remote devices running Extreme Networks NOS

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to a NOS device and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(nos_config) to configure NOS devices.

Nos Config *arguments

Manage Extreme Networks NOS configuration sections

Arguments: multiline_delimiter, src, backup_options, after, lines, intended_config, diff_against, parents, before, running_config, replace, backup, match, diff_ignore_lines

Extreme NOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with NOS configuration sections in a deterministic way.

Nos Facts *arguments

Collect facts from devices running Extreme NOS

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running NOS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Nosh *arguments

Manage services with nosh

Arguments: state, preset, enabled, name, user

Control running and enabled state for system-wide or user services. BSD and Linux systems are supported.

Npm *arguments

Manage node.js packages with npm

Arguments: executable, name, global, ci, ignore_scripts, state, production, unsafe_perm, registry, version, path

Manage node.js packages with Node Package Manager (npm)

Nso Action *arguments

Executes Cisco NSO actions and verifies output.

Arguments: path, output_required, validate_strict, input, output_invalid

This module provides support for executing Cisco NSO actions and then verifying that the output is as expected.

Nso Config *arguments

Manage Cisco NSO configuration and service synchronization.

Arguments: data

This module provides support for managing configuration in Cisco NSO and can also ensure services are in sync.

Nso Query *arguments

Query data from Cisco NSO.

Arguments: xpath, fields

This module provides support for querying data from Cisco NSO using XPath.

Nso Show *arguments

Displays data from Cisco NSO.

Arguments: path, operational

This module provides support for displaying data from Cisco NSO.

Nso Verify *arguments

Verifies Cisco NSO configuration.

Arguments: data

This module provides support for verifying Cisco NSO configuration is in compliance with specified values.

Nsupdate *arguments

Manage DNS records.

Arguments: key_algorithm, protocol, zone, key_name, value, server, record, state, ttl, type, port, key_secret

Create, update and remove DNS records using DDNS updates

Nuage Vspk *arguments

Manage Nuage VSP environments

Arguments: parent_type, auth, properties, match_filter, parent_id, state, command, id, type, children

Manage or find Nuage VSP entities, this includes create, update, delete, assign, unassign and find, with all supported properties.

Nxos Aaa Server *arguments

Manages AAA server global configuration.

Arguments: state, server_timeout, deadtime, directed_request, server_type, encrypt_type, global_key

Manages AAA server global configuration

Nxos Aaa Server Host *arguments

Manages AAA server host-specific configuration.

Arguments: server_type, encrypt_type, auth_port, tacacs_port, host_timeout, state, key, address, acct_port

Manages AAA server host-specific configuration.

Nxos Acl *arguments

Manages access list entries for ACLs.

Arguments: src_port_op, psh, seq, src, dest, syn, dscp, time_range, dest_port_op, rst, dest_port2, name, established, remark, urg, log, proto, ack, src_port1, precedence, state, action, dest_port1, fragments, fin, src_port2

Manages access list entries for ACLs.

Nxos Acl Interface *arguments

Manages applying ACLs to interfaces.

Arguments: interface, direction, name, state

Manages applying ACLs to interfaces.

Nxos Banner *arguments

Manage multiline banners on Cisco NXOS devices

Arguments: text, state, banner

This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remote banner text from the active running configuration.

Nxos Bfd Global *arguments

Bidirectional Forwarding Detection (BFD) global-level configuration

Arguments: echo_rx_interval, ipv6_interval, interval, startup_timer, fabricpath_vlan, ipv4_slow_timer, fabricpath_interval, ipv4_interval, ipv6_echo_rx_interval, fabricpath_slow_timer, slow_timer, ipv4_echo_rx_interval, echo_interface, ipv6_slow_timer

Manages Bidirectional Forwarding Detection (BFD) global-level configuration.

Nxos Bfd Interfaces *arguments

Manages BFD attributes of nxos interfaces.

Arguments: state, config

Manages attributes of Bidirectional Forwarding Detection (BFD) on the interface.

Nxos Bgp *arguments

Manages BGP configuration.

Arguments: neighbor_down_fib_accelerate, confederation_peers, confederation_id, event_history_cli, bestpath_always_compare_med, cluster_id, shutdown, log_neighbor_changes, bestpath_aspath_multipath_relax, graceful_restart_timers_stalepath_time, maxas_limit, bestpath_med_confed, isolate, timer_bgp_keepalive, bestpath_cost_community_ignore, fast_external_fallover, state, disable_policy_batching, suppress_fib_pending, bestpath_med_missing_as_worst, router_id, timer_bestpath_limit, bestpath_compare_neighborid, local_as, event_history_periodic, disable_policy_batching_ipv4_prefix_list, vrf, graceful_restart_helper, timer_bgp_hold, event_history_events, asn, disable_policy_batching_ipv6_prefix_list, event_history_detail, graceful_restart, flush_routes, enforce_first_as, bestpath_med_non_deterministic, reconnect_interval, graceful_restart_timers_restart, bestpath_compare_routerid

Manages BGP configurations on NX-OS switches.

Nxos Bgp Af *arguments

Manages BGP Address-family configuration.

Arguments: dampening_max_suppress_time, additional_paths_send, additional_paths_install, dampening_state, additional_paths_receive, suppress_inactive, dampening_routemap, distance_ibgp, distance_local, advertise_l2vpn_evpn, afi, default_information_originate, networks, state, next_hop_route_map, table_map_filter, safi, default_metric, client_to_client, dampen_igp_metric, additional_paths_selection, maximum_paths_ibgp, vrf, distance_ebgp, asn, redistribute, dampening_reuse_time, maximum_paths, inject_map, dampening_suppress_time, table_map, dampening_half_time

Manages BGP Address-family configurations on NX-OS switches.

Nxos Bgp Neighbor *arguments

Manages BGP neighbors configurations.

Arguments: update_source, maximum_peers, description, local_as, pwd_type, timers_keepalive, dynamic_capability, vrf, shutdown, low_memory_exempt, log_neighbor_changes, remove_private_as, suppress_4_byte_as, connected_check, remote_as, ebgp_multihop, bfd, pwd, asn, state, transport_passive_only, timers_holdtime, neighbor, capability_negotiation

Manages BGP neighbors configurations on NX-OS switches.

Nxos Bgp Neighbor Af *arguments

Manages BGP address-family's neighbors configuration.

Arguments: default_originate, route_reflector_client, additional_paths_send, soo, additional_paths_receive, suppress_inactive, unsuppress_map, prefix_list_out, as_override, filter_list_out, afi, allowas_in, max_prefix_warning, max_prefix_threshold, state, advertise_map_non_exist, default_originate_route_map, send_community, disable_peer_as_check, safi, filter_list_in, weight, vrf, max_prefix_limit, asn, route_map_in, soft_reconfiguration_in, max_prefix_interval, route_map_out, next_hop_self, prefix_list_in, neighbor, next_hop_third_party, advertise_map_exist, allowas_in_max

Manages BGP address-family's neighbors configurations on NX-OS switches.

Nxos Command *arguments

Run arbitrary command on Cisco NXOS devices

Arguments: retries, commands, wait_for, match, interval

Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Nxos Config *arguments

Manage Cisco NXOS configuration sections

Arguments: backup_options, after, diff_against, replace, running_config, diff_ignore_lines, src, replace_src, lines, intended_config, parents, defaults, before, save_when, backup, match

Cisco NXOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with NXOS configuration sections in a deterministic way. This module works with either CLI or NXAPI transports.

Nxos Evpn Global *arguments

Handles the EVPN control plane for VXLAN.

Arguments: nv_overlay_evpn

Handles the EVPN control plane for VXLAN.

Nxos Evpn Vni *arguments

Manages Cisco EVPN VXLAN Network Identifier (VNI).

Arguments: state, route_distinguisher, route_target_import, route_target_export, route_target_both, vni

Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device.

Nxos Facts *arguments

Gets facts about NX-OS switches

Arguments: gather_subset, gather_network_resources

Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both Cli and Nxapi transports. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Nxos Feature *arguments

Manage features in NX-OS switches.

Arguments: state, feature

Offers ability to enable and disable features in NX-OS.

Nxos File Copy *arguments

Copy a file to a remote NXOS device.

Arguments: file_pull_timeout, local_file, local_file_directory, remote_scp_server, connect_ssh_port, remote_scp_server_user, remote_scp_server_password, vrf, file_pull_compact, file_pull_kstack, remote_file, file_system, file_pull

This module supports two different workflows for copying a file to flash (or bootflash) on NXOS devices. Files can either be (1) pushed from the Ansible controller to the device or (2) pulled from a remote SCP file server to the device. File copies are initiated from the NXOS device to the remote SCP server. This module only supports the use of connection C(network_cli) or C(Cli) transport with connection C(local).

Nxos Gir *arguments

Trigger a graceful removal or insertion (GIR) of the switch.

Arguments: system_mode_maintenance_on_reload_reset_reason, system_mode_maintenance, state, system_mode_maintenance_dont_generate_profile, system_mode_maintenance_shutdown, system_mode_maintenance_timeout

Trigger a graceful removal or insertion (GIR) of the switch.

Nxos Gir Profile Management *arguments

Create a maintenance-mode or normal-mode profile for GIR.

Arguments: commands, mode, state

Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion.

Nxos Hsrp *arguments

Manages HSRP configuration on NX-OS switches.

Arguments: auth_type, group, preempt, auth_string, vip, priority, state, version, interface

Manages HSRP configuration on NX-OS switches.

Nxos Igmp *arguments

Manages IGMP global configuration.

Arguments: state, enforce_rtr_alert, restart, flush_routes

Manages IGMP global configuration configuration settings.

Nxos Igmp Interface *arguments

Manages IGMP interface configuration.

Arguments: startup_query_interval, group_timeout, robustness, oif_routemap, oif_prefix, interface, querier_timeout, last_member_query_count, restart, report_llg, last_member_qrt, oif_ps, startup_query_count, immediate_leave, state, version, oif_source, query_interval, query_mrt

Manages IGMP interface configuration settings.

Nxos Igmp Snooping *arguments

Manages IGMP snooping global configuration.

Arguments: link_local_grp_supp, report_supp, snooping, group_timeout, v3_report_supp, state

Manages IGMP snooping global configuration.

Nxos Install Os *arguments

Set boot options like boot, kickstart image and issu.

Arguments: issu, system_image_file, kickstart_image_file

Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade).

Nxos Interface Ospf *arguments

Manages configuration of an OSPF interface instance.

Arguments: cost, hello_interval, bfd, message_digest_algorithm_type, message_digest_key_id, area, message_digest_encryption_type, state, dead_interval, passive_interface, message_digest_password, interface, ospf, message_digest, network

Manages configuration of an OSPF interface instance.

Nxos Interfaces *arguments

Manages interface attributes of NX-OS Interfaces

Arguments: state, config

This module manages the interface attributes of NX-OS interfaces.

Nxos L2 Interfaces *arguments

Manages Layer-2 Interfaces attributes of NX-OS Interfaces

Arguments: state, config

This module manages Layer-2 interfaces attributes of NX-OS Interfaces.

Nxos L3 Interfaces *arguments

Manages Layer-3 Interfaces attributes of NX-OS Interfaces

Arguments: state, config

This module manages Layer-3 interfaces attributes of NX-OS Interfaces.

Nxos Lacp *arguments

Manage Global Link Aggregation Control Protocol (LACP) on Cisco NX-OS devices.

Arguments: state, config

This module manages Global Link Aggregation Control Protocol (LACP) on NX-OS devices.

Nxos Lacp Interfaces *arguments

Manage Link Aggregation Control Protocol (LACP) attributes of interfaces on Cisco NX-OS devices.

Arguments: state, config

This module manages Link Aggregation Control Protocol (LACP) attributes of NX-OS Interfaces.

Nxos Lag Interfaces *arguments

Manages link aggregation groups of NX-OS Interfaces

Arguments: state, config

This module manages attributes of link aggregation groups of NX-OS Interfaces.

Nxos Lldp *arguments

Manage LLDP configuration on Cisco NXOS network devices.

Arguments: state

This module provides declarative management of LLDP service on Cisco NXOS network devices.

Nxos Lldp Global *arguments

Configure and manage Link Layer Discovery Protocol(LLDP) attributes on NX-OS platforms.

Arguments: state, config

This module configures and manages the Link Layer Discovery Protocol(LLDP) attributes on NX-OS platforms.

Nxos Logging *arguments

Manage logging on network devices

Arguments: facility_level, facility, dest, timestamp, interface_message, interface, facility_link_status, file_size, aggregate, event, name, remote_server, dest_level, purge, state, use_vrf

This module provides declarative management of logging on Cisco NX-OS devices.

Nxos Ntp *arguments

Manages core NTP configuration.

Arguments: source_addr, prefer, server, state, vrf_name, peer, key_id, source_int

Manages core NTP configuration.

Nxos Ntp Auth *arguments

Manages NTP authentication.

Arguments: auth_type, state, key_id, trusted_key, authentication, md5string

Manages NTP authentication.

Nxos Ntp Options *arguments

Manages NTP options.

Arguments: master, state, logging, stratum

Manages NTP options, e.g. authoritative server and logging.

Nxos Nxapi *arguments

Manage NXAPI configuration on an NXOS device.

Arguments: http_port, http, https_port, tlsv1_0, tlsv1_1, sandbox, ssl_strong_ciphers, state, https, tlsv1_2

Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the C(Cli) transport.

Nxos Ospf *arguments

Manages configuration of an ospf instance.

Arguments: state, ospf

Manages configuration of an ospf instance.

Nxos Ospf Vrf *arguments

Manages a VRF for an OSPF router.

Arguments: router_id, timer_throttle_lsa_max, timer_throttle_spf_max, auto_cost, timer_throttle_lsa_hold, bfd, default_metric, log_adjacency, timer_throttle_lsa_start, state, vrf, passive_interface, timer_throttle_spf_start, ospf, timer_throttle_spf_hold

Manages a VRF for an OSPF router.

Nxos Overlay Global *arguments

Configures anycast gateway MAC of the switch.

Arguments: anycast_gateway_mac

Configures anycast gateway MAC of the switch.

Nxos Pim *arguments

Manages configuration of a PIM instance.

Arguments: ssm_range, bfd

Manages configuration of a Protocol Independent Multicast (PIM) instance.

Nxos Pim Interface *arguments

Manages PIM interface configuration.

Arguments: hello_auth_key, dr_prio, hello_interval, jp_type_in, bfd, jp_policy_out, neighbor_type, state, neighbor_policy, sparse, interface, jp_policy_in, border, jp_type_out

Manages PIM interface configuration settings.

Nxos Pim Rp Address *arguments

Manages configuration of an PIM static RP address instance.

Arguments: bidir, state, route_map, prefix_list, rp_address, group_list

Manages configuration of an Protocol Independent Multicast (PIM) static rendezvous point (RP) address instance.

Nxos Ping *arguments

Tests reachability using ping from Nexus switch.

Arguments: dest, count, state, vrf, source

Tests reachability using ping from switch to a remote destination. For a general purpose network module, see the M(net_ping) module. For Windows targets, use the M(win_ping) module instead. For targets running Python, use the M(ping) module instead.

Nxos Reboot *arguments

Reboot a network device.

Arguments: confirm

Reboot a network device.

Nxos Rollback *arguments

Set a checkpoint or rollback to a checkpoint.

Arguments: checkpoint_file, rollback_to

This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches.

Nxos Rpm *arguments

Install patch or feature rpms on Cisco NX-OS devices.

Arguments: aggregate, state, pkg, file_system

Install software maintenance upgrade (smu) RPMS and 3rd party RPMS on Cisco NX-OS devices.

Nxos Smu *arguments

Perform SMUs on Cisco NX-OS devices.

Arguments: pkg, file_system

Perform software maintenance upgrades (SMUs) on Cisco NX-OS devices.

Nxos Snapshot *arguments

Manage snapshots of the running states of selected features.

Arguments: description, section, snapshot1, comparison_results_file, snapshot2, element_key1, element_key2, snapshot_name, save_snapshot_locally, action, path, row_id, show_command, compare_option

Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots.

Nxos Snmp Community *arguments

Manages SNMP community configs.

Arguments: access, state, group, community, acl

Manages SNMP community configuration.

Nxos Snmp Contact *arguments

Manages SNMP contact info.

Arguments: state, contact

Manages SNMP contact information.

Nxos Snmp Host *arguments

Manages SNMP host configuration.

Arguments: vrf_filter, udp, src_intf, snmp_host, community, state, version, v3, snmp_type, vrf

Manages SNMP host configuration parameters.

Nxos Snmp Location *arguments

Manages SNMP location information.

Arguments: state, location

Manages SNMP location configuration.

Nxos Snmp Traps *arguments

Manages SNMP traps.

Arguments: state, group

Manages SNMP traps configurations.

Nxos Snmp User *arguments

Manages SNMP users for monitoring.

Arguments: authentication, state, encrypt, user, privacy, group, pwd

Manages SNMP user configuration.

Nxos Static Route *arguments

Manages static route configuration

Arguments: prefix, track, pref, route_name, state, tag, next_hop, aggregate, vrf

Manages static route configuration

Nxos System *arguments

Manage the system attributes on Cisco NXOS devices

Arguments: domain_lookup, state, name_servers, domain_search, hostname, system_mtu, domain_name

This module provides declarative management of node system attributes on Cisco NXOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Nxos Telemetry *arguments

Telemetry Monitoring Service (TMS) configuration

Arguments: state, config

Manages Telemetry Monitoring Service (TMS) configuration

Nxos Udld *arguments

Manages UDLD global configuration params.

Arguments: reset, msg_time, aggressive, state

Manages UDLD global configuration params.

Nxos Udld Interface *arguments

Manages UDLD interface configuration params.

Arguments: interface, state, mode

Manages UDLD interface configuration params.

Nxos User *arguments

Manage the collection of local users on Nexus devices

Arguments: update_password, configured_password, name, purge, state, role, aggregate, sshkey

This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Nxos Vlans *arguments

Create VLAN and manage VLAN configurations on NX-OS Interfaces

Arguments: state, config

This module creates and manages VLAN configurations on Cisco NX-OS Interfaces.

Nxos Vpc *arguments

Manages global VPC configuration

Arguments: domain, system_priority, role_priority, auto_recovery, pkl_vrf, delay_restore, delay_restore_interface_vlan, peer_gw, auto_recovery_reload_delay, state, pkl_dest, pkl_src, delay_restore_orphan_port

Manages global VPC configuration

Nxos Vpc Interface *arguments

Manages interface VPC configuration

Arguments: state, vpc, portchannel, peer_link

Manages interface VPC configuration

Nxos Vrf *arguments

Manages global VRF configuration.

Arguments: rd, name, interfaces, vni, purge, associated_interfaces, state, delay, admin_state, aggregate, description

This module provides declarative management of VRFs on CISCO NXOS network devices.

Nxos Vrf Af *arguments

Manages VRF AF.

Arguments: state, route_target_both_auto_evpn, vrf, afi

Manages VRF AF

Nxos Vrf Interface *arguments

Manages interface specific VRF configuration.

Arguments: interface, state, vrf

Manages interface specific VRF configuration.

Nxos Vrrp *arguments

Manages VRRP configuration on NX-OS switches.

Arguments: group, preempt, interval, vip, authentication, priority, state, admin_state, interface

Manages VRRP configuration on NX-OS switches.

Nxos Vtp Domain *arguments

Manages VTP domain configuration.

Arguments: domain

Manages VTP domain configuration.

Nxos Vtp Password *arguments

Manages VTP password configuration.

Arguments: vtp_password, state

Manages VTP password configuration.

Nxos Vtp Version *arguments

Manages VTP version configuration.

Arguments: version

Manages VTP version configuration.

Nxos Vxlan Vtep *arguments

Manages VXLAN Network Virtualization Endpoint (NVE).

Arguments: global_mcast_group_L2, global_mcast_group_L3, description, global_ingress_replication_bgp, global_suppress_arp, host_reachability, source_interface_hold_down_time, state, shutdown, source_interface, interface

Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels.

Nxos Vxlan Vtep Vni *arguments

Creates a Virtual Network Identifier member (VNI)

Arguments: assoc_vrf, peer_list, vni, multicast_group, state, suppress_arp_disable, interface, ingress_replication, suppress_arp

Creates a Virtual Network Identifier member (VNI) for an NVE overlay interface.

Oci Vcn *arguments

Manage Virtual Cloud Networks(VCN) in OCI

Arguments: vcn_id, state, dns_label, display_name, compartment_id, cidr_block

This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI. The complete Oracle Cloud Infrastructure Ansible Modules can be downloaded from U(https://github.com/oracle/oci-ansible-modules/releases).

Office 365 Connector Card *arguments

Use webhooks to create Connector Card messages within an Office 365 group

Arguments: sections, title, color, text, webhook, actions, summary

Creates Connector Card messages through Office 365 Connectors U(https://dev.outlook.com/Connectors)

Ohai *arguments

Returns inventory data from I(Ohai)

Arguments:

Similar to the M(facter) module, this runs the I(Ohai) discovery program (U(https://docs.chef.io/ohai.html)) on the remote host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter).

Omapi Host *arguments

Setup OMAPI hosts.

Arguments: macaddr, statements, key_name, hostname, state, host, ddns, key, ip, port

Manage OMAPI hosts into compatible DHCPd servers

Ome Device Info *arguments

Retrieves the information about Device.

Arguments: username, system_query_options, password, fact_subset, hostname, port

This module retrieves the list of all devices information with the exhaustive inventory of each device.

One Host *arguments

Manages OpenNebula Hosts

Arguments: vmm_mad_name, name, im_mad_name, labels, cluster_name, state, cluster_id, template

Manages OpenNebula Hosts

One Image *arguments

Manages OpenNebula images

Arguments: new_name, api_url, api_password, enabled, state, api_username, id, name

Manages OpenNebula images

One Image Info *arguments

Gather information on OpenNebula images

Arguments: api_username, api_password, ids, name, api_url

Gather information on OpenNebula images. This module was called C(one_image_facts) before Ansible 2.9. The usage did not change.

One Service *arguments

Deploy and manage OpenNebula services

Arguments: custom_attrs, force, template_name, api_username, api_password, wait_timeout, cardinality, wait, unique, api_url, state, role, mode, service_name, service_id, group_id, template_id, owner_id

Manage OpenNebula services

One Vm *arguments

Creates or terminates OpenNebula instances

Arguments: hard, template_name, labels, api_password, instance_ids, count_labels, wait_timeout, networks, disk_saveas, wait, count, disk_size, api_url, vcpu, exact_count, template_id, api_username, state, count_attributes, mode, memory, attributes, group_id, cpu, vm_start_on_hold, owner_id

Manages OpenNebula instances

Oneandone Firewall Policy *arguments

Configure 1&1 firewall policy.

Arguments: add_rules, firewall_policy, name, rules, auth_token, remove_server_ips, wait_interval, state, wait_timeout, add_server_ips, api_url, wait, remove_rules, description

Create, remove, reconfigure, update firewall policies. This module has a dependency on 1and1 >= 1.0

Oneandone Load Balancer *arguments

Configure 1&1 load balancer.

Arguments: add_rules, load_balancer, description, health_check_parse, rules, auth_token, health_check_test, wait_timeout, add_server_ips, health_check_path, wait, datacenter, persistence_time, health_check_interval, api_url, wait_interval, remove_server_ips, name, state, remove_rules, method, persistence

Create, remove, update load balancers. This module has a dependency on 1and1 >= 1.0

Oneandone Monitoring Policy *arguments

Configure 1&1 monitoring policy.

Arguments: add_ports, name, thresholds, agent, email, wait_timeout, monitoring_policy, remove_servers, update_ports, description, processes, api_url, wait_interval, remove_processes, add_servers, state, update_processes, remove_ports, add_processes, wait, auth_token, ports

Create, remove, update monitoring policies (and add/remove ports, processes, and servers). This module has a dependency on 1and1 >= 1.0

Oneandone Private Network *arguments

Configure 1&1 private networking.

Arguments: datacenter, description, wait_interval, auth_token, network_address, name, subnet_mask, state, wait_timeout, add_members, private_network, wait, remove_members, api_url

Create, remove, reconfigure, update a private network. This module has a dependency on 1and1 >= 1.0

Oneandone Public Ip *arguments

Configure 1&1 public IPs.

Arguments: datacenter, api_url, wait_interval, auth_token, reverse_dns, state, wait_timeout, public_ip_id, type, wait

Create, update, and remove public IPs. This module has a dependency on 1and1 >= 1.0

Oneandone Server *arguments

Create, destroy, start, stop, and reboot a 1&1 Host server.

Arguments: load_balancer, vcore, description, server_type, auto_increment, auth_token, ram, ssh_key, wait_timeout, private_network, monitoring_policy, wait, count, datacenter, firewall_policy, api_url, cores_per_processor, hdds, wait_interval, hostname, appliance, server, state, fixed_instance_size

Create, destroy, update, start, stop, and reboot a 1&1 Host server. When the server is created it can optionally wait for it to be 'running' before returning.

Onepassword Info *arguments

Gather items from 1Password

Arguments: cli_path, search_terms, auto_login

M(onepassword_info) wraps the C(op) command line utility to fetch data about one or more 1Password items. A fatal error occurs if any of the items being searched for can not be found. Recommend using with the C(no_log) option to avoid logging the values of the secrets being retrieved. This module was called C(onepassword_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(onepassword_info) module no longer returns C(ansible_facts)! You must now use the C(register) option to use the facts in other tasks.

Oneview Datacenter Info *arguments

Retrieve information about the OneView Data Centers

Arguments: name, options

Retrieve information about the OneView Data Centers. This module was called C(oneview_datacenter_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_datacenter_info) module no longer returns C(ansible_facts)!

Oneview Enclosure Info *arguments

Retrieve information about one or more Enclosures

Arguments: name, options

Retrieve information about one or more of the Enclosures from OneView. This module was called C(oneview_enclosure_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_enclosure_info) module no longer returns C(ansible_facts)!

Oneview Ethernet Network *arguments

Manage OneView Ethernet Network resources

Arguments: state, data

Provides an interface to manage Ethernet Network resources. Can create, update, or delete.

Oneview Ethernet Network Info *arguments

Retrieve the information about one or more of the OneView Ethernet Networks

Arguments: name, options

Retrieve the information about one or more of the Ethernet Networks from OneView. This module was called C(oneview_ethernet_network_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_ethernet_network_info) module no longer returns C(ansible_facts)!

Oneview Fc Network *arguments

Manage OneView Fibre Channel Network resources.

Arguments: state, data

Provides an interface to manage Fibre Channel Network resources. Can create, update, and delete.

Oneview Fc Network Info *arguments

Retrieve the information about one or more of the OneView Fibre Channel Networks

Arguments: name

Retrieve the information about one or more of the Fibre Channel Networks from OneView. This module was called C(oneview_fc_network_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_fc_network_info) module no longer returns C(ansible_facts)!

Oneview Fcoe Network *arguments

Manage OneView FCoE Network resources

Arguments: state, data

Provides an interface to manage FCoE Network resources. Can create, update, or delete.

Oneview Fcoe Network Info *arguments

Retrieve the information about one or more of the OneView FCoE Networks

Arguments: name

Retrieve the information about one or more of the FCoE Networks from OneView. This module was called C(oneview_fcoe_network_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_fcoe_network_info) module no longer returns C(ansible_facts)!

Oneview Logical Interconnect Group *arguments

Manage OneView Logical Interconnect Group resources

Arguments: state, data

Provides an interface to manage Logical Interconnect Group resources. Can create, update, or delete.

Oneview Logical Interconnect Group Info *arguments

Retrieve information about one or more of the OneView Logical Interconnect Groups

Arguments: name

Retrieve information about one or more of the Logical Interconnect Groups from OneView This module was called C(oneview_logical_interconnect_group_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_logical_interconnect_group_info) module no longer returns C(ansible_facts)!

Oneview Network Set *arguments

Manage HPE OneView Network Set resources

Arguments: state, data

Provides an interface to manage Network Set resources. Can create, update, or delete.

Oneview Network Set Info *arguments

Retrieve information about the OneView Network Sets

Arguments: name, options

Retrieve information about the Network Sets from OneView. This module was called C(oneview_network_set_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_network_set_info) module no longer returns C(ansible_facts)!

Oneview San Manager *arguments

Manage OneView SAN Manager resources

Arguments: state, data

Provides an interface to manage SAN Manager resources. Can create, update, or delete.

Oneview San Manager Info *arguments

Retrieve information about one or more of the OneView SAN Managers

Arguments: provider_display_name, params

Retrieve information about one or more of the SAN Managers from OneView This module was called C(oneview_san_manager_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(oneview_san_manager_info) module no longer returns C(ansible_facts)!

Online Server Info *arguments

Gather information about Online servers.

Arguments:

Gather information about the servers. U(https://www.online.net/en/dedicated-server)

Online User Info *arguments

Gather information about Online user.

Arguments:

Gather information about the user.

Onyx Bgp *arguments

Configures BGP on Mellanox ONYX network devices

Arguments: router_id, as_number, neighbors, max_paths, fast_external_fallover, purge, state, vrf, ecmp_bestpath, evpn, networks

This module provides declarative management of BGP router and neighbors on Mellanox ONYX network devices.

Onyx Buffer Pool *arguments

Configures Buffer Pool

Arguments: pool_type, memory_percent, name, switch_priority

This module provides declarative management of Onyx Buffer Pool configuration on Mellanox ONYX network devices.

Onyx Command *arguments

Run commands on remote devices running Mellanox ONYX

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an Mellanox ONYX network device and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(onyx_config) to configure Mellanox ONYX devices.

Onyx Config *arguments

Manage Mellanox ONYX configuration sections

Arguments: src, backup_options, backup, after, lines, replace, parents, save, config, match, before

Mellanox ONYX configurations uses a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with ONYX configuration sections in a deterministic way.

Onyx Facts *arguments

Collect facts from Mellanox ONYX network devices

Arguments: gather_subset

Collects a base set of device facts from a ONYX Mellanox network devices This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Onyx Igmp *arguments

Configures IGMP global parameters

Arguments: default_version, last_member_query_interval, unregistered_multicast, state, report_suppression_interval, proxy_reporting, mrouter_timeout, port_purge_timeout

This module provides declarative management of IGMP protocol params on Mellanox ONYX network devices.

Onyx Igmp Interface *arguments

Configures IGMP interface parameters

Arguments: state, name

This module provides declarative management of IGMP interface configuration on Mellanox ONYX network devices.

Onyx Igmp Vlan *arguments

Configures IGMP Vlan parameters

Arguments: state, version, querier, mrouter, static_groups, vlan_id

This module provides declarative management of IGMP vlan configuration on Mellanox ONYX network devices.

Onyx Interface *arguments

Manage Interfaces on Mellanox ONYX network devices

Arguments: rx_rate, name, duplex, enabled, mtu, delay, purge, state, aggregate, speed, tx_rate, description

This module provides declarative management of Interfaces on Mellanox ONYX network devices.

Onyx L2 Interface *arguments

Manage Layer-2 interface on Mellanox ONYX network devices

Arguments: access_vlan, state, trunk_allowed_vlans, name, aggregate, mode

This module provides declarative management of Layer-2 interface on Mellanox ONYX network devices.

Onyx L3 Interface *arguments

Manage L3 interfaces on Mellanox ONYX network devices

Arguments: purge, state, name, ipv6, aggregate, ipv4

This module provides declarative management of L3 interfaces on Mellanox ONYX network devices.

Onyx Linkagg *arguments

Manage link aggregation groups on Mellanox ONYX network devices

Arguments: purge, state, name, members, aggregate, mode

This module provides declarative management of link aggregation groups on Mellanox ONYX network devices.

Onyx Lldp *arguments

Manage LLDP configuration on Mellanox ONYX network devices

Arguments: state

This module provides declarative management of LLDP service configuration on Mellanox ONYX network devices.

Onyx Lldp Interface *arguments

Manage LLDP interfaces configuration on Mellanox ONYX network devices

Arguments: aggregate, purge, state, name

This module provides declarative management of LLDP interfaces configuration on Mellanox ONYX network devices.

Onyx Magp *arguments

Manage MAGP protocol on Mellanox ONYX network devices

Arguments: interface, router_mac, state, router_ip, magp_id

This module provides declarative management of MAGP protocol on vlan interface of Mellanox ONYX network devices.

Onyx Mlag Ipl *arguments

Manage IPL (inter-peer link) on Mellanox ONYX network devices

Arguments: vlan_interface, state, name, peer_address

This module provides declarative management of IPL (inter-peer link) management on Mellanox ONYX network devices.

Onyx Mlag Vip *arguments

Configures MLAG VIP on Mellanox ONYX network devices

Arguments: delay, state, group_name, ipaddress, mac_address

This module provides declarative management of MLAG virtual IPs on Mellanox ONYX network devices.

Onyx Ospf *arguments

Manage OSPF protocol on Mellanox ONYX network devices

Arguments: router_id, interfaces, ospf, state

This module provides declarative management and configuration of OSPF protocol on Mellanox ONYX network devices.

Onyx Pfc Interface *arguments

Manage priority flow control on ONYX network devices

Arguments: aggregate, purge, state, name

This module provides declarative management of priority flow control (PFC) on interfaces of Mellanox ONYX network devices.

Onyx Protocol *arguments

Enables/Disables protocols on Mellanox ONYX network devices

Arguments: spanning_tree, lldp, mlag, magp, ip_routing, lacp, nve, ip_l3, igmp_snooping, dcb_pfc, ospf, bgp

This module provides a mechanism for enabling and disabling protocols Mellanox on ONYX network devices.

Onyx Ptp Global *arguments

Configures PTP Global parameters

Arguments: primary_priority, domain, ptp_state, ntp_state, secondary_priority

This module provides declarative management of PTP Global configuration on Mellanox ONYX network devices.

Onyx Ptp Interface *arguments

Configures PTP on interface

Arguments: sync_interval, announce_interval, name, delay_request, state, announce_timeout

This module provides declarative management of PTP interfaces configuration on Mellanox ONYX network devices.

Onyx Qos *arguments

Configures QoS

Arguments: interfaces, trust, rewrite_dscp, rewrite_pcp

This module provides declarative management of Onyx QoS configuration on Mellanox ONYX network devices.

Onyx Traffic Class *arguments

Configures Traffic Class

Arguments: interfaces, state, dcb, congestion_control, tc

This module provides declarative management of Traffic Class configuration on Mellanox ONYX network devices.

Onyx Vlan *arguments

Manage VLANs on Mellanox ONYX network devices

Arguments: aggregate, purge, state, name, vlan_id

This module provides declarative management of VLANs on Mellanox ONYX network devices.

Onyx Vxlan *arguments

Configures Vxlan

Arguments: arp_suppression, bgp, loopback_id, vni_vlan_list, nve_id, mlag_tunnel_ip

This module provides declarative management of Vxlan configuration on Mellanox ONYX network devices.

Onyx Wjh *arguments

Configure what-just-happend module

Arguments: clear_group, group, export_group, enabled, auto_export

This module provides declarative management of wjh on Mellanox ONYX network devices.

Open Iscsi *arguments

Manage iSCSI targets with Open-iSCSI

Arguments: auto_node_startup, target, show_nodes, node_auth, node_pass, discover, portal, login, node_user, port

Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets.

Openbsd Pkg *arguments

Manage packages on OpenBSD

Arguments: state, ports_dir, clean, quick, name, build

Manage packages on OpenBSD using the pkg tools.

Opendj Backendprop *arguments

Will update the backend configuration of OpenDJ via the dsconfig set-backend-prop command.

Arguments: username, name, hostname, value, state, passwordfile, password, opendj_bindir, port, backend

This module will update settings for OpenDJ with the command set-backend-prop. It will check first via de get-backend-prop if configuration needs to be applied.

Openssh Cert *arguments

Generate OpenSSH host or user certificates.

Arguments: public_key, valid_from, force, signing_key, options, state, valid_to, path, serial_number, identifier, type, principals, valid_at

Generate and regenerate OpenSSH host or user certificates.

Openssh Keypair *arguments

Generate OpenSSH private and public keys.

Arguments: comment, state, force, path, type, size

This module allows one to (re)generate OpenSSH private and public keys. It uses ssh-keygen to generate keys. One can generate C(rsa), C(dsa), C(rsa1), C(ed25519) or C(ecdsa) private keys.

Openssl Certificate *arguments

Generate and/or check OpenSSL certificates

Arguments: privatekey_passphrase, subject_alt_name_strict, signature_algorithms, force, csr_path, acme_chain, ownca_privatekey_path, selfsigned_create_subject_key_identifier, ownca_privatekey_passphrase, key_usage, valid_in, path, entrust_api_key, not_before, issuer, ownca_version, subject_strict, selfsigned_version, has_expired, entrust_requester_phone, state, version, provider, selfsigned_digest, entrust_not_after, subject, ownca_create_authority_key_identifier, key_usage_strict, ownca_create_subject_key_identifier, subject_alt_name, extended_key_usage_strict, entrust_requester_name, selfsigned_not_after, acme_challenge_path, privatekey_path, entrust_requester_email, ownca_path, ownca_not_after, issuer_strict, ownca_not_before, invalid_at, entrust_cert_type, entrust_api_specification_path, acme_accountkey_path, ownca_digest, extended_key_usage, entrust_api_user, not_after, entrust_api_client_cert_key_path, selfsigned_not_before, entrust_api_client_cert_path, select_crypto_backend, backup, valid_at

This module allows one to (re)generate OpenSSL certificates. It implements a notion of provider (ie. C(selfsigned), C(ownca), C(acme), C(assertonly), C(entrust)) for your certificate. The C(assertonly) provider is intended for use cases where one is only interested in checking properties of a supplied certificate. Please note that this provider has been deprecated in Ansible 2.9 and will be removed in Ansible 2.13. See the examples on how to emulate C(assertonly) usage with M(openssl_certificate_info), M(openssl_csr_info), M(openssl_privatekey_info) and M(assert). This also allows more flexible checks than the ones offered by the C(assertonly) provider. The C(ownca) provider is intended for generating OpenSSL certificate signed with your own CA (Certificate Authority) certificate (self-signed certificate). Many properties that can be specified in this module are for validation of an existing or newly generated certificate. The proper place to specify them, if you want to receive a certificate with these properties is a CSR (Certificate Signing Request). Please note that the module regenerates existing certificate if it doesn't match the module's options, or if it seems to be corrupt. If you are concerned that this could overwrite your existing certificate, consider using the I(backup) option. It uses the pyOpenSSL or cryptography python library to interact with OpenSSL. If both the cryptography and PyOpenSSL libraries are available (and meet the minimum version requirements) cryptography will be preferred as a backend over PyOpenSSL (unless the backend is forced with C(select_crypto_backend)). Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13.

Openssl Certificate Info *arguments

Provide information of OpenSSL X.509 certificates

Arguments: select_crypto_backend, path, valid_at

This module allows one to query information on OpenSSL certificates. It uses the pyOpenSSL or cryptography python library to interact with OpenSSL. If both the cryptography and PyOpenSSL libraries are available (and meet the minimum version requirements) cryptography will be preferred as a backend over PyOpenSSL (unless the backend is forced with C(select_crypto_backend)). Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13.

Openssl Csr *arguments

Generate OpenSSL Certificate Signing Request (CSR)

Arguments: privatekey_passphrase, force, authority_cert_issuer, create_subject_key_identifier, subject_alt_name_critical, ocsp_must_staple, key_usage, path, common_name, email_address, digest, subject, organizational_unit_name, locality_name, organization_name, state, version, country_name, state_or_province_name, extended_key_usage_critical, subject_alt_name, authority_key_identifier, basic_constraints, privatekey_path, authority_cert_serial_number, key_usage_critical, extended_key_usage, ocsp_must_staple_critical, subject_key_identifier, use_common_name_for_san, basic_constraints_critical, select_crypto_backend, backup

This module allows one to (re)generate OpenSSL certificate signing requests. It uses the pyOpenSSL python library to interact with openssl. This module supports the subjectAltName, keyUsage, extendedKeyUsage, basicConstraints and OCSP Must Staple extensions. Please note that the module regenerates existing CSR if it doesn't match the module's options, or if it seems to be corrupt. If you are concerned that this could overwrite your existing CSR, consider using the I(backup) option. The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available. This can be overridden with the I(select_crypto_backend) option. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13."

Openssl Csr Info *arguments

Provide information of OpenSSL Certificate Signing Requests (CSR)

Arguments: select_crypto_backend, path

This module allows one to query information on OpenSSL Certificate Signing Requests (CSR). In case the CSR signature cannot be validated, the module will fail. In this case, all return variables are still returned. It uses the pyOpenSSL or cryptography python library to interact with OpenSSL. If both the cryptography and PyOpenSSL libraries are available (and meet the minimum version requirements) cryptography will be preferred as a backend over PyOpenSSL (unless the backend is forced with C(select_crypto_backend)). Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13.

Openssl Dhparam *arguments

Generate OpenSSL Diffie-Hellman Parameters

Arguments: path, state, force, backup, size

This module allows one to (re)generate OpenSSL DH-params. This module uses file common arguments to specify generated file permissions. Please note that the module regenerates existing DH params if they don't match the module's options. If you are concerned that this could overwrite your existing DH params, consider using the I(backup) option.

Openssl Pkcs12 *arguments

Generate OpenSSL PKCS#12 archive

Arguments: privatekey_passphrase, src, force, maciter_size, friendly_name, privatekey_path, state, certificate_path, passphrase, other_certificates, action, path, backup, iter_size

This module allows one to (re-)generate PKCS#12.

Openssl Privatekey *arguments

Generate OpenSSL private keys

Arguments: force, type, curve, state, cipher, passphrase, select_crypto_backend, path, backup, size

This module allows one to (re)generate OpenSSL private keys. One can generate L(RSA,https://en.wikipedia.org/wiki/RSA_%28cryptosystem%29), L(DSA,https://en.wikipedia.org/wiki/Digital_Signature_Algorithm), L(ECC,https://en.wikipedia.org/wiki/Elliptic-curve_cryptography) or L(EdDSA,https://en.wikipedia.org/wiki/EdDSA) private keys. Keys are generated in PEM format. Please note that the module regenerates private keys if they don't match the module's options. In particular, if you provide another passphrase (or specify none), change the keysize, etc., the private key will be regenerated. If you are concerned that this could *overwrite your private key*, consider using the I(backup) option. The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available. This can be overridden with the I(select_crypto_backend) option. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13."

Openssl Privatekey Info *arguments

Provide information for OpenSSL private keys

Arguments: select_crypto_backend, path, return_private_key_data, passphrase

This module allows one to query information on OpenSSL private keys. In case the key consistency checks fail, the module will fail as this indicates a faked private key. In this case, all return variables are still returned. Note that key consistency checks are not available all key types; if none is available, C(none) is returned for C(key_is_consistent). It uses the pyOpenSSL or cryptography python library to interact with OpenSSL. If both the cryptography and PyOpenSSL libraries are available (and meet the minimum version requirements) cryptography will be preferred as a backend over PyOpenSSL (unless the backend is forced with C(select_crypto_backend)). Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13.

Openssl Publickey *arguments

Generate an OpenSSL public key from its private key.

Arguments: privatekey_passphrase, force, format, privatekey_path, state, select_crypto_backend, path, backup

This module allows one to (re)generate OpenSSL public keys from their private keys. Keys are generated in PEM or OpenSSH format. The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available. This can be overridden with the I(select_crypto_backend) option. When I(format) is C(OpenSSH), the C(cryptography) backend has to be used. Please note that the PyOpenSSL backend was deprecated in Ansible 2.9 and will be removed in Ansible 2.13."

Openvswitch Bridge *arguments

Manage Open vSwitch bridges

Arguments: bridge, fail_mode, parent, vlan, state, set, timeout, external_ids

Manage Open vSwitch bridges

Openvswitch Db *arguments

Configure open vswitch database.

Arguments: record, state, key, timeout, table, col, value

Set column values in record in database table.

Openvswitch Port *arguments

Manage Open vSwitch ports

Arguments: bridge, state, set, timeout, external_ids, tag, port

Manage Open vSwitch ports

Openwrt Init *arguments

Manage services on OpenWrt.

Arguments: pattern, state, enabled, name

Controls OpenWrt services on remote hosts.

Opkg *arguments

Package manager for OpenWrt

Arguments: force, state, update_cache, name

Manages OpenWrt packages

Opx Cps *arguments

CPS operations on networking device running Openswitch (OPX)

Arguments: qualifier, operation, module_name, commit_event, db, attr_data, attr_type

Executes the given operation on the YANG object, using CPS API in the networking device running OpenSwitch (OPX). It uses the YANG models provided in https://github.com/open-switch/opx-base-model.

Ordnance Config *arguments

Manage Ordnance configuration sections

Arguments: multiline_delimiter, src, backup, after, lines, replace, parents, defaults, save, config, match, before

Ordnance router configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with these configuration sections in a deterministic way.

Ordnance Facts *arguments

Collect facts from Ordnance Virtual Routers over SSH

Arguments: gather_subset

Collects a base set of device facts from an Ordnance Virtual router over SSH. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Os Auth *arguments

Retrieve an auth token

Arguments: availability_zone

Retrieve an auth token from an OpenStack Cloud

Os Client Config *arguments

Get OpenStack Client config

Arguments: clouds

Get I(openstack) client config data from clouds.yaml or environment

Os Coe Cluster *arguments

Add/Remove COE cluster from OpenStack Cloud

Arguments: cluster_template_id, docker_volume_size, availability_zone, labels, keypair, master_count, state, flavor_id, timeout, node_count, master_flavor_id, discovery_url, name

Add or Remove COE cluster from the OpenStack Container Infra service.

Os Coe Cluster Template *arguments

Add/Remove COE cluster template from OpenStack Cloud

Arguments: labels, docker_volume_size, availability_zone, external_network_id, http_proxy, network_driver, image_id, volume_driver, registry_enabled, floating_ip_enabled, fixed_subnet, master_flavor_id, docker_storage_driver, name, no_proxy, server_type, state, fixed_network, https_proxy, tls_disabled, coe, keypair_id, master_lb_enabled, public, dns_nameserver, flavor_id

Add or Remove COE cluster template from the OpenStack Container Infra service.

Os Flavor Info *arguments

Retrieve information about one or more flavors

Arguments: vcpus, limit, name, availability_zone, ram, ephemeral

Retrieve information about available OpenStack instance flavors. By default, information about ALL flavors are retrieved. Filters can be applied to get information for only matching flavors. For example, you can filter on the amount of RAM available to the flavor, or the number of virtual CPUs available to the flavor, or both. When specifying multiple filters, ALL filters must match on a flavor before that flavor is returned as a fact. This module was called C(os_flavor_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_flavor_info) module no longer returns C(ansible_facts)!

Os Floating Ip *arguments

Add/Remove floating IP from an instance

Arguments: fixed_address, network, availability_zone, reuse, nat_destination, purge, state, floating_ip_address, timeout, server, wait

Add or Remove a floating IP to an instance. Returns the floating IP when attaching only if I(wait=true).

Os Group *arguments

Manage OpenStack Identity Groups

Arguments: state, description, domain_id, name, availability_zone

Manage OpenStack Identity Groups. Groups can be created, deleted or updated. Only the I(description) value can be updated.

Os Group Info *arguments

Retrieve info about one or more OpenStack groups

Arguments: domain, name, filters, availability_zone

Retrieve info about a one or more OpenStack groups.

Os Image *arguments

Add/Delete images from OpenStack Cloud

Arguments: ramdisk, kernel, availability_zone, container_format, min_ram, owner, min_disk, is_public, properties, name, checksum, id, disk_format, filename, state, protected

Add or Remove images from the OpenStack Image Repository

Os Image Info *arguments

Retrieve information about an image within OpenStack.

Arguments: image, properties, availability_zone

Retrieve information about a image image from OpenStack. This module was called C(os_image_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_image_info) module no longer returns C(ansible_facts)!

Os Ironic *arguments

Create/Delete Bare Metal Resources from OpenStack

Arguments: uuid, driver_info, availability_zone, nics, driver, state, ironic_url, chassis_uuid, skip_update_of_driver_password, properties, name

Create or Remove Ironic nodes from OpenStack.

Os Ironic Inspect *arguments

Explicitly triggers baremetal node introspection in ironic.

Arguments: ironic_url, uuid, timeout, availability_zone, mac, name

Requests Ironic to set a node into inspect state in order to collect metadata regarding the node. This command may be out of band or in-band depending on the ironic driver configuration. This is only possible on nodes in 'manageable' and 'available' state.

Os Ironic Node *arguments

Activate/Deactivate Bare Metal Resources from OpenStack

Arguments: maintenance, uuid, power, deploy, availability_zone, state, maintenance_reason, ironic_url, timeout, config_drive, instance_info, wait

Deploy to nodes controlled by Ironic.

Os Keypair *arguments

Add/Delete a keypair from OpenStack

Arguments: public_key, state, public_key_file, name, availability_zone

Add or Remove key pair from OpenStack

Os Keystone Domain *arguments

Manage OpenStack Identity Domains

Arguments: state, description, enabled, name, availability_zone

Create, update, or delete OpenStack Identity domains. If a domain with the supplied name already exists, it will be updated with the new description and enabled attributes.

Os Keystone Domain Info *arguments

Retrieve information about one or more OpenStack domains

Arguments: name, filters, availability_zone

Retrieve information about a one or more OpenStack domains This module was called C(os_keystone_domain_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_keystone_domain_info) module no longer returns C(ansible_facts)!

Os Keystone Endpoint *arguments

Manage OpenStack Identity service endpoints

Arguments: state, service, url, endpoint_interface, region, enabled

Create, update, or delete OpenStack Identity service endpoints. If a service with the same combination of I(service), I(interface) and I(region) exist, the I(url) and I(state) (C(present) or C(absent)) will be updated.

Os Keystone Role *arguments

Manage OpenStack Identity Roles

Arguments: state, name, availability_zone

Manage OpenStack Identity Roles.

Os Keystone Service *arguments

Manage OpenStack Identity services

Arguments: state, name, availability_zone, service_type, enabled, description

Create, update, or delete OpenStack Identity service. If a service with the supplied name already exists, it will be updated with the new description and enabled attributes.

Os Listener *arguments

Add/Delete a listener for a load balancer from OpenStack Cloud

Arguments: protocol, name, availability_zone, state, timeout, protocol_port, loadbalancer, wait

Add or Remove a listener for a load balancer from the OpenStack load-balancer service.

Os Loadbalancer *arguments

Add/Delete load balancer from OpenStack Cloud

Arguments: name, availability_zone, vip_port, public_ip_address, vip_address, delete_public_ip, auto_public_ip, state, vip_network, timeout, public_network, vip_subnet, listeners, wait

Add or Remove load balancer from the OpenStack load-balancer service(Octavia). Load balancer update is not supported for now.

Os Member *arguments

Add/Delete a member for a pool in load balancer from OpenStack Cloud

Arguments: name, availability_zone, subnet_id, state, timeout, address, protocol_port, pool, wait

Add or Remove a member for a pool from the OpenStack load-balancer service.

Os Network *arguments

Creates/removes networks from OpenStack

Arguments: name, provider_network_type, admin_state_up, availability_zone, dns_domain, provider_physical_network, project, state, provider_segmentation_id, external, shared, port_security_enabled, mtu

Add or remove network from OpenStack.

Os Networks Info *arguments

Retrieve information about one or more OpenStack networks.

Arguments: name, filters, availability_zone

Retrieve information about one or more networks from OpenStack. This module was called C(os_networks_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_networks_info) module no longer returns C(ansible_facts)!

Os Nova Flavor *arguments

Manage OpenStack compute flavors

Arguments: disk, name, availability_zone, ram, ephemeral, state, vcpus, extra_specs, swap, rxtx_factor, is_public, flavorid

Add or remove flavors from OpenStack.

Os Nova Host Aggregate *arguments

Manage OpenStack host aggregates

Arguments: state, metadata, hosts, name, availability_zone

Create, update, or delete OpenStack host aggregates. If a aggregate with the supplied name already exists, it will be updated with the new name, new availability zone, new metadata and new list of hosts.

Os Object *arguments

Create or Delete objects and containers from OpenStack

Arguments: state, container, name, availability_zone, container_access, filename

Create or Delete objects and containers from OpenStack

Os Pool *arguments

Add/Delete a pool in the load balancing service from OpenStack Cloud

Arguments: lb_algorithm, protocol, name, availability_zone, listener, state, timeout, loadbalancer, wait

Add or Remove a pool from the OpenStack load-balancer service.

Os Port *arguments

Add/Update/Delete ports from an OpenStack cloud.

Arguments: network, allowed_address_pairs, admin_state_up, extra_dhcp_opts, availability_zone, device_owner, name, state, no_security_groups, mac_address, port_security_enabled, vnic_type, fixed_ips, security_groups, device_id

Add, Update or Remove ports from an OpenStack cloud. A I(state) of 'present' will ensure the port is created or updated if required.

Os Port Info *arguments

Retrieve information about ports within OpenStack.

Arguments: port, filters, availability_zone

Retrieve information about ports from OpenStack. This module was called C(os_port_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_port_info) module no longer returns C(ansible_facts)!

Os Project *arguments

Manage OpenStack Projects

Arguments: state, name, availability_zone, enabled, domain_id, description

Manage OpenStack Projects. Projects can be created, updated or deleted using this module. A project will be updated if I(name) matches an existing project and I(state) is present. The value for I(name) cannot be updated without deleting and re-creating the project.

Os Project Access *arguments

Manage OpenStack compute flavors access

Arguments: state, resource_name, target_project_id, resource_type, availability_zone

Add or remove flavor, volume_type or other resources access from OpenStack.

Os Project Info *arguments

Retrieve information about one or more OpenStack projects

Arguments: domain, name, filters, availability_zone

Retrieve information about a one or more OpenStack projects This module was called C(os_project_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_project_info) module no longer returns C(ansible_facts)!

Os Quota *arguments

Manage OpenStack Quotas

Arguments: snapshots_lvm, server_groups, availability_zone, ram, snapshots, instances, backups, fixed_ips, port, subnet, per_volume_gigabytes, network, floatingip, volumes_lvm, floating_ips, properties, security_group_rule, state, injected_files, gigabytes_lvm, injected_path_size, gigabytes, backup_gigabytes, subnetpool, key_pairs, injected_file_size, cores, rbac_policy, pool, name, server_group_members, volumes, security_group, router, loadbalancer

Manage OpenStack Quotas. Quotas can be created, updated or deleted using this module. A quota will be updated if matches an existing project and is present.

Os Recordset *arguments

Manage OpenStack DNS recordsets

Arguments: name, zone, availability_zone, records, state, ttl, recordset_type, description

Manage OpenStack DNS recordsets. Recordsets can be created, deleted or updated. Only the I(records), I(description), and I(ttl) values can be updated.

Os Router *arguments

Create or delete routers from OpenStack

Arguments: enable_snat, network, admin_state_up, interfaces, availability_zone, name, project, state, external_fixed_ips

Create or Delete routers from OpenStack. Although Neutron allows routers to share the same name, this module enforces name uniqueness to be more user friendly.

Os Security Group *arguments

Add/Delete security groups from an OpenStack cloud.

Arguments: project, state, description, name, availability_zone

Add or Remove security groups from an OpenStack cloud.

Os Security Group Rule *arguments

Add/Delete rule from an existing security group

Arguments: direction, protocol, availability_zone, remote_ip_prefix, port_range_max, project, state, port_range_min, ethertype, security_group, remote_group

Add or Remove rule from an existing security group

Os Server *arguments

Create/Delete Compute Instances from OpenStack

Arguments: volumes, name, availability_zone, key_name, image, image_exclude, boot_volume, flavor_include, meta, terminate_volume, flavor, delete_fip, security_groups, scheduler_hints, boot_from_volume, userdata, network, nics, floating_ips, flavor_ram, volume_size, state, auto_ip, config_drive, timeout, wait, reuse_ips, floating_ip_pools

Create or Remove compute instances from OpenStack.

Os Server Action *arguments

Perform actions on Compute Instances from OpenStack

Arguments: timeout, availability_zone, action, image, wait, server

Perform server actions on an existing compute instance from OpenStack. This module does not return any data other than changed true/false. When I(action) is 'rebuild', then I(image) parameter is required.

Os Server Group *arguments

Manage OpenStack server groups

Arguments: state, name, policies, availability_zone

Add or remove server groups from OpenStack.

Os Server Info *arguments

Retrieve information about one or more compute instances

Arguments: detailed, server, filters, all_projects, availability_zone

Retrieve information about server instances from OpenStack. This module was called C(os_server_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_server_info) module no longer returns C(ansible_facts)!

Os Server Metadata *arguments

Add/Update/Delete Metadata in Compute Instances from OpenStack

Arguments: state, meta, server, availability_zone

Add, Update or Remove metadata in compute instances from OpenStack.

Os Server Volume *arguments

Attach/Detach Volumes from OpenStack VM's

Arguments: volume, device, state, server, availability_zone

Attach or Detach volumes from OpenStack VM's

Os Stack *arguments

Add/Remove Heat Stack

Arguments: rollback, name, parameters, availability_zone, environment, state, tag, timeout, template

Add or Remove a Stack to an OpenStack Heat

Os Subnet *arguments

Add/Remove subnet to an OpenStack network

Arguments: no_gateway_ip, use_default_subnetpool, availability_zone, ipv6_ra_mode, extra_specs, ipv6_address_mode, cidr, network_name, allocation_pool_end, name, enable_dhcp, dns_nameservers, project, state, allocation_pool_start, gateway_ip, ip_version, host_routes

Add or Remove a subnet to an OpenStack network

Os Subnets Info *arguments

Retrieve information about one or more OpenStack subnets.

Arguments: name, filters, availability_zone

Retrieve information about one or more subnets from OpenStack. This module was called C(os_subnets_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_subnets_info) module no longer returns C(ansible_facts)!

Os User *arguments

Manage OpenStack Identity Users

Arguments: update_password, description, availability_zone, enabled, default_project, state, domain, password, email, name

Manage OpenStack Identity users. Users can be created, updated or deleted using this module. A user will be updated if I(name) matches an existing user and I(state) is present. The value for I(name) cannot be updated without deleting and re-creating the user.

Os User Group *arguments

Associate OpenStack Identity users and groups

Arguments: state, group, user, availability_zone

Add and remove users from groups

Os User Info *arguments

Retrieve information about one or more OpenStack users

Arguments: domain, name, filters, availability_zone

Retrieve information about a one or more OpenStack users This module was called C(os_user_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(os_user_info) module no longer returns C(ansible_facts)!

Os User Role *arguments

Associate OpenStack Identity users and roles

Arguments: project, domain, group, user, availability_zone, role, state

Grant and revoke roles in either project or domain context for OpenStack Identity Users.

Os Volume *arguments

Create/Delete Cinder Volumes

Arguments: size, display_name, availability_zone, image, volume_type, volume, state, display_description, snapshot_id, scheduler_hints, metadata

Create or Remove cinder block storage volumes

Os Volume Snapshot *arguments

Create/Delete Cinder Volume Snapshots

Arguments: volume, state, force, availability_zone, display_name, display_description

Create or Delete cinder block storage volume snapshots

Os Zone *arguments

Manage OpenStack DNS zones

Arguments: masters, description, availability_zone, state, ttl, zone_type, email, name

Manage OpenStack DNS zones. Zones can be created, deleted or updated. Only the I(email), I(description), I(ttl) and I(masters) values can be updated.

Osx Defaults *arguments

Manage macOS user defaults

Arguments: domain, host, value, state, key, path, type, array_add

osx_defaults allows users to read, write, and delete macOS user defaults from Ansible scripts. macOS applications and other programs use the defaults system to record user preferences and other information that must be maintained when the applications are not running (such as default font for new documents, or the position of an Info panel).

Ovh Ip Failover *arguments

Manage OVH IP failover address

Arguments: endpoint, name, service, wait_task_completion, application_key, application_secret, timeout, consumer_key, wait_completion

Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move an ip failover (or failover block) between services

Ovh Ip Loadbalancing Backend *arguments

Manage OVH IP LoadBalancing backends

Arguments: endpoint, name, weight, probe, application_key, state, application_secret, timeout, consumer_key, backend

Manage OVH (French European hosting provider) LoadBalancing IP backends

Ovirt *arguments

oVirt/RHEV platform management

Arguments: instance_mem, instance_cores, instance_cpus, image, instance_hostname, instance_disksize, instance_nic, user, instance_network, instance_type, password, sdomain, instance_os, instance_ip, zone, disk_alloc, url, region, instance_dns, instance_name, instance_netmask, state, instance_key, instance_domain, instance_rootpw, resource_type, disk_int

This module only supports oVirt/RHEV version 3. A newer module M(ovirt_vm) supports oVirt/RHV version 4. Allows you to create new instances, either from scratch or an image, in addition to deleting or stopping instances on the oVirt/RHEV platform.

Ovirt Affinity Group *arguments

Module to manage affinity groups in oVirt/RHV

Arguments: vm_enforcing, name, host_rule, cluster, state, hosts, vm_rule, host_enforcing, vms, description

This module manage affinity groups in oVirt/RHV. It can also manage assignments of those groups to VMs.

Ovirt Affinity Label *arguments

Module to manage affinity labels in oVirt/RHV

Arguments: cluster, state, hosts, name, vms

This module manage affinity labels in oVirt/RHV. It can also manage assignments of those labels to hosts and VMs.

Ovirt Affinity Label Info *arguments

Retrieve information about one or more oVirt/RHV affinity labels

Arguments: host, name, vm

Retrieve information about one or more oVirt/RHV affinity labels. This module was called C(ovirt_affinity_label_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_affinity_label_info) module no longer returns C(ansible_facts)!

Ovirt Api Info *arguments

Retrieve information about the oVirt/RHV API

Arguments:

Retrieve information about the oVirt/RHV API. This module was called C(ovirt_api_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_api_info) module no longer returns C(ansible_facts)!

Ovirt Auth *arguments

Module to manage authentication to oVirt/RHV

Arguments: username, hostname, ca_file, url, insecure, kerberos, compress, state, headers, token, timeout, password

This module authenticates to oVirt/RHV engine and creates SSO token, which should be later used in all other oVirt/RHV modules, so all modules don't need to perform login and logout. This module returns an Ansible fact called I(ovirt_auth). Every module can use this fact as C(auth) parameter, to perform authentication.

Ovirt Cluster *arguments

Module to manage clusters in oVirt/RHV

Arguments: comment, ha_reservation, fence_skip_if_connectivity_broken, mac_pool, virt, threads_as_cores, gluster, vm_reason, migration_bandwidth_limit, switch_type, data_center, ksm_numa, id, description, cpu_arch, rng_sources, network, gluster_tuned_profile, scheduling_policy_properties, state, fence_skip_if_gluster_quorum_not_met, ksm, external_network_providers, migration_compressed, ballooning, migration_auto_converge, fence_enabled, migration_policy, firewall_type, fence_skip_if_gluster_bricks_up, resilience_policy, fence_connectivity_threshold, spice_proxy, memory_policy, migration_bandwidth, fence_skip_if_sd_active, scheduling_policy, compatibility_version, serial_policy_value, name, host_reason, cpu_type, serial_policy, trusted_service

Module to manage clusters in oVirt/RHV

Ovirt Cluster Info *arguments

Retrieve information about one or more oVirt/RHV clusters

Arguments: pattern

Retrieve information about one or more oVirt/RHV clusters. This module was called C(ovirt_cluster_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_cluster_info) module no longer returns C(ansible_facts)!

Ovirt Datacenter *arguments

Module to manage data centers in oVirt/RHV

Arguments: comment, compatibility_version, force, description, mac_pool, local, state, quota_mode, id, name

Module to manage data centers in oVirt/RHV

Ovirt Datacenter Info *arguments

Retrieve information about one or more oVirt/RHV datacenters

Arguments: pattern

Retrieve information about one or more oVirt/RHV datacenters. This module was called C(ovirt_datacenter_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_datacenter_info) module no longer returns C(ansible_facts)!

Ovirt Disk *arguments

Module to manage Virtual Machine and floating disks in oVirt/RHV

Arguments: profile, vm_name, storage_domains, activate, force, description, sparsify, wipe_after_delete, logical_unit, quota_id, host, download_image_path, content_type, interface, vm_id, id, size, storage_domain, openstack_volume_type, bootable, format, upload_image_path, name, state, shareable, sparse, image_provider

Module to manage Virtual Machine and floating disks in oVirt/RHV.

Ovirt Disk Info *arguments

Retrieve information about one or more oVirt/RHV disks

Arguments: pattern

Retrieve information about one or more oVirt/RHV disks. This module was called C(ovirt_disk_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_disk_info) module no longer returns C(ansible_facts)!

Ovirt Event *arguments

Create or delete an event in oVirt/RHV

Arguments: origin, custom_id, storage_domain, description, state, vm, cluster, host, user, template, data_center, id, severity

This module can be used to create or delete an event in oVirt/RHV.

Ovirt Event Info *arguments

This module can be used to retrieve information about one or more oVirt/RHV events

Arguments: headers, search, query, max, from_, wait, case_sensitive

Retrieve information about one or more oVirt/RHV events. This module was called C(ovirt_event_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_event_info) module no longer returns C(ansible_facts)!

Ovirt External Provider *arguments

Module to manage external providers in oVirt/RHV

Arguments: username, read_only, name, url, tenant_name, state, authentication_url, data_center, authentication_keys, password, type, network_type, description

Module to manage external providers in oVirt/RHV

Ovirt External Provider Info *arguments

Retrieve information about one or more oVirt/RHV external providers

Arguments: type, name

Retrieve information about one or more oVirt/RHV external providers. This module was called C(ovirt_external_provider_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_external_provider_info) module no longer returns C(ansible_facts)!

Ovirt Group *arguments

Module to manage groups in oVirt/RHV

Arguments: authz_name, state, namespace, name

Module to manage groups in oVirt/RHV

Ovirt Group Info *arguments

Retrieve information about one or more oVirt/RHV groups

Arguments: pattern

Retrieve information about one or more oVirt/RHV groups. This module was called C(ovirt_group_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_group_info) module no longer returns C(ansible_facts)!

Ovirt Host *arguments

Module to manage hosts in oVirt/RHV

Arguments: comment, activate, force, public_key, address, power_management_enabled, cluster, hosted_engine, override_iptables, password, id, vgpu_placement, check_upgrade, reboot_after_upgrade, kdump_integration, name, spm_priority, iscsi, kernel_params, state, timeout, override_display

Module to manage hosts in oVirt/RHV

Ovirt Host Info *arguments

Retrieve information about one or more oVirt/RHV hosts

Arguments: all_content, pattern, cluster_version

Retrieve information about one or more oVirt/RHV hosts. This module was called C(ovirt_host_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_host_info) module no longer returns C(ansible_facts)!

Ovirt Host Network *arguments

Module to manage host networks in oVirt/RHV

Arguments: name, labels, networks, state, interface, save, sync_networks, check, bond

Module to manage host networks in oVirt/RHV.

Ovirt Host Pm *arguments

Module to manage power management of hosts in oVirt/RHV

Arguments: username, password, name, order, port, state, address, encrypt_options, type, options

Module to manage power management of hosts in oVirt/RHV.

Ovirt Host Storage Info *arguments

Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage)

Arguments: fcp, host, iscsi

Retrieve information about one or more oVirt/RHV HostStorages (applicable only for block storage). This module was called C(ovirt_host_storage_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_host_storage_info) module no longer returns C(ansible_facts)!

Ovirt Instance Type *arguments

Module to manage Instance Types in oVirt/RHV

Arguments: graphical_console, rng_device, memory_guaranteed, virtio_scsi, placement_policy, boot_devices, serial_console, usb_support, rng_period, host, io_threads, cpu_threads, watchdog, memory_max, id, cpu_sockets, high_availability, operating_system, soundcard_enabled, name, rng_bytes, high_availability_priority, nics, description, cpu_pinning, cpu_cores, ballooning_enabled, cpu_mode, state, smartcard_enabled, memory

This module manages whole lifecycle of the Instance Type in oVirt/RHV.

Ovirt Job *arguments

Module to manage jobs in oVirt/RHV

Arguments: state, steps, description

This module manage jobs in oVirt/RHV. It can also manage steps of the job.

Ovirt Mac Pool *arguments

Module to manage MAC pools in oVirt/RHV

Arguments: ranges, allow_duplicates, state, description, id, name

This module manage MAC pools in oVirt/RHV.

Ovirt Network *arguments

Module to manage logical networks in oVirt/RHV

Arguments: comment, external_provider, description, mtu, state, vm_network, data_center, clusters, vlan_tag, label, id, name

Module to manage logical networks in oVirt/RHV

Ovirt Network Info *arguments

Retrieve information about one or more oVirt/RHV networks

Arguments: pattern

Retrieve information about one or more oVirt/RHV networks. This module was called C(ovirt_network_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_network_info) module no longer returns C(ansible_facts)!

Ovirt Nic *arguments

Module to manage network interfaces of Virtual Machines in oVirt/RHV

Arguments: profile, network, vm, id, state, template, mac_address, interface, linked, name

Module to manage network interfaces of Virtual Machines in oVirt/RHV.

Ovirt Nic Info *arguments

Retrieve information about one or more oVirt/RHV virtual machine network interfaces

Arguments: vm, name

Retrieve information about one or more oVirt/RHV virtual machine network interfaces. This module was called C(ovirt_nic_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_nic_info) module no longer returns C(ansible_facts)!

Ovirt Permission *arguments

Module to manage permissions of users/groups in oVirt/RHV

Arguments: authz_name, object_type, namespace, state, object_id, group_name, object_name, role, quota_name, user_name

Module to manage permissions of users/groups in oVirt/RHV.

Ovirt Permission Info *arguments

Retrieve information about one or more oVirt/RHV permissions

Arguments: namespace, group_name, authz_name, user_name

Retrieve information about one or more oVirt/RHV permissions. This module was called C(ovirt_permission_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_permission_info) module no longer returns C(ansible_facts)!

Ovirt Quota *arguments

Module to manage datacenter quotas in oVirt/RHV

Arguments: description, cluster_grace, cluster_threshold, state, storage_grace, storage_threshold, data_center, clusters, storages, id, name

Module to manage datacenter quotas in oVirt/RHV

Ovirt Quota Info *arguments

Retrieve information about one or more oVirt/RHV quotas

Arguments: name, data_center

Retrieve information about one or more oVirt/RHV quotas. This module was called C(ovirt_quota_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_quota_info) module no longer returns C(ansible_facts)!

Ovirt Role *arguments

Module to manage roles in oVirt/RHV

Arguments: state, description, permits, administrative, id, name

Module to manage roles in oVirt/RHV.

Ovirt Scheduling Policy Info *arguments

Retrieve information about one or more oVirt scheduling policies

Arguments: id, name

Retrieve information about one or more oVirt scheduling policies. This module was called C(ovirt_scheduling_policy_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_scheduling_policy_info) module no longer returns C(ansible_facts)!

Ovirt Snapshot *arguments

Module to manage Virtual Machine Snapshots in oVirt/RHV

Arguments: vm_name, description, use_memory, upload_image_path, disk_id, keep_days_old, state, download_image_path, snapshot_id, disk_name

Module to manage Virtual Machine Snapshots in oVirt/RHV

Ovirt Snapshot Info *arguments

Retrieve information about one or more oVirt/RHV virtual machine snapshots

Arguments: description, vm, snapshot_id

Retrieve information about one or more oVirt/RHV virtual machine snapshots. This module was called C(ovirt_snapshot_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_snapshot_info) module no longer returns C(ansible_facts)!

Ovirt Storage Connection *arguments

Module to manage storage connections in oVirt

Arguments: username, force, mount_options, address, nfs_timeout, path, password, nfs_version, target, id, storage, nfs_retrans, port, state, vfs_type, type

Module to manage storage connections in oVirt

Ovirt Storage Domain *arguments

Module to manage storage domains in oVirt/RHV

Arguments: comment, fcp, description, format, warning_low_space, glusterfs, localfs, discard_after_delete, managed_block_storage, data_center, id, domain_function, name, critical_space_action_blocker, iscsi, posixfs, host, state, nfs, wipe_after_delete, destroy, backup

Module to manage storage domains in oVirt/RHV

Ovirt Storage Domain Info *arguments

Retrieve information about one or more oVirt/RHV storage domains

Arguments: pattern

Retrieve information about one or more oVirt/RHV storage domains. This module was called C(ovirt_storage_domain_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_storage_domain_info) module no longer returns C(ansible_facts)!

Ovirt Storage Template Info *arguments

Retrieve information about one or more oVirt/RHV templates relate to a storage domain.

Arguments: unregistered, storage_domain, max

Retrieve information about one or more oVirt/RHV templates relate to a storage domain. This module was called C(ovirt_storage_template_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_storage_template_info) module no longer returns C(ansible_facts)!

Ovirt Storage Vm Info *arguments

Retrieve information about one or more oVirt/RHV virtual machines relate to a storage domain.

Arguments: unregistered, storage_domain, max

Retrieve information about one or more oVirt/RHV virtual machines relate to a storage domain. This module was called C(ovirt_storage_vm_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_storage_vm_info) module no longer returns C(ansible_facts)!

Ovirt Tag *arguments

Module to manage tags in oVirt/RHV

Arguments: state, hosts, description, parent, name, id, vms

This module manage tags in oVirt/RHV. It can also manage assignments of those tags to entities.

Ovirt Tag Info *arguments

Retrieve information about one or more oVirt/RHV tags

Arguments: host, name, vm

Retrieve information about one or more oVirt/RHV tags. This module was called C(ovirt_tag_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_tag_info) module no longer returns C(ansible_facts)!

Ovirt Template *arguments

Module to manage virtual machine templates in oVirt/RHV

Arguments: exclusive, cpu_profile, cloud_init_nics, vm, cluster, io_threads, seal, timezone, memory_max, id, image_provider, storage_domain, domain_mappings, export_domain, nics, template_image_disk_name, sysprep, ballooning_enabled, state, version, clone_name, memory, clone_permissions, vnic_profile_mappings, image_disk, usb_support, sso, role_mappings, soundcard_enabled, description, operating_system, name, cloud_init, memory_guaranteed, smartcard_enabled, allow_partial_import, cluster_mappings

Module to manage virtual machine templates in oVirt/RHV.

Ovirt Template Info *arguments

Retrieve information about one or more oVirt/RHV templates

Arguments: pattern

Retrieve information about one or more oVirt/RHV templates. This module was called C(ovirt_template_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_template_info) module no longer returns C(ansible_facts)!

Ovirt User *arguments

Module to manage users in oVirt/RHV

Arguments: authz_name, state, namespace, name

Module to manage users in oVirt/RHV.

Ovirt User Info *arguments

Retrieve information about one or more oVirt/RHV users

Arguments: pattern

Retrieve information about one or more oVirt/RHV users. This module was called C(ovirt_user_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_user_info) module no longer returns C(ansible_facts)!

Ovirt Vm *arguments

Module to manage Virtual Machines in oVirt/RHV

Arguments: comment, exclusive, cloud_init_nics, boot_menu, xen, custom_compatibility_version, instance_type, graphical_console, snapshot_name, force_migrate, watchdog, memory_max, cpu_sockets, high_availability, storage_domain, domain_mappings, disk_format, cpu_cores, ballooning_enabled, memory_guaranteed, export_ova, memory, clone_permissions, type, initrd_path, lease, vnic_profile_mappings, lun_mappings, serial_console, reassign_bad_macs, sso, cpu_threads, quota_id, numa_nodes, ticket, use_latest_template_version, affinity_group_mappings, operating_system, serial_policy_value, name, cpu_pinning, cpu_shares, affinity_label_mappings, next_run, disks, force, placement_policy, migrate, usb_support, cluster, io_threads, kernel_params_persist, timezone, id, vmware, snapshot_vm, soundcard_enabled, high_availability_priority, export_domain, nics, custom_properties, sysprep, cpu_mode, state, template, cd_iso, cloud_init_persist, kernel_path, rng_device, description, boot_devices, clone, kvm, host, role_mappings, serial_policy, stateless, cloud_init, template_version, numa_tune_mode, kernel_params, host_devices, smartcard_enabled, allow_partial_import, cluster_mappings, delete_protected

This module manages whole lifecycle of the Virtual Machine(VM) in oVirt/RHV. Since VM can hold many states in oVirt/RHV, this see notes to see how the states of the VM are handled.

Ovirt Vm Info *arguments

Retrieve information about one or more oVirt/RHV virtual machines

Arguments: all_content, pattern, case_sensitive, next_run, max

Retrieve information about one or more oVirt/RHV virtual machines. This module was called C(ovirt_vm_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_vm_info) module no longer returns C(ansible_facts)!

Ovirt Vmpool *arguments

Module to manage VM pools in oVirt/RHV

Arguments: comment, description, vm, name, vm_per_user, cluster, state, prestarted, template, type, id, vm_count

Module to manage VM pools in oVirt/RHV.

Ovirt Vmpool Info *arguments

Retrieve information about one or more oVirt/RHV vmpools

Arguments: pattern

Retrieve information about one or more oVirt/RHV vmpools. This module was called C(ovirt_vmpool_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(ovirt_vmpool_info) module no longer returns C(ansible_facts)!

Ovirt Vnic Profile *arguments

Module to manage vNIC profile of network in oVirt/RHV

Arguments: migratable, qos, pass_through, description, name, state, custom_properties, data_center, network_filter, port_mirroring, network

Module to manage vNIC profile of network in oVirt/RHV

Pacemaker Cluster *arguments

Manage pacemaker clusters

Arguments: node, state, force, timeout

This module can manage a pacemaker cluster and nodes from Ansible using the pacemaker cli.

Package *arguments

Generic OS package manager

Arguments: state, use, name

Installs, upgrade and removes packages using the underlying OS package manager. For Windows targets, use the M(win_package) module instead.

Package Facts *arguments

package information as facts

Arguments: manager, strategy

Return information about installed packages as facts

Packet Device *arguments

Manage a bare metal server in the Packet Host.

Arguments: features, facility, wait_for_public_IPv, auth_token, count_offset, user_data, always_pxe, hostnames, plan, ipxe_script_url, count, operating_system, locked, device_ids, state, wait_timeout, project_id

Manage a bare metal server in the Packet Host (a "device" in the API terms). When the machine is created it can optionally wait for public IP address, or for active state. This module has a dependency on packet >= 1.0. API is documented at U(https://www.packet.net/developers/api/devices).

Packet Sshkey *arguments

Create/delete an SSH key in Packet host.

Arguments: state, key, fingerprint, id, auth_token, key_file, label

Create/delete an SSH key in Packet host. API is documented at U(https://www.packet.net/help/api/#page:ssh-keys,header:ssh-keys-ssh-keys-post).

Pacman *arguments

Manage packages with I(pacman)

Arguments: upgrade, force, name, recurse, extra_args, state, update_cache, update_cache_extra_args, upgrade_extra_args

Manage packages with the I(pacman) package manager, which is used by Arch Linux and its variants.

Pagerduty *arguments

Create PagerDuty maintenance windows

Arguments: name, service, state, minutes, window_id, hours, token, user, requester_id, validate_certs, desc

This module will let you create PagerDuty maintenance windows

Pagerduty Alert *arguments

Trigger, acknowledge or resolve PagerDuty incidents

Arguments: client_url, name, state, incident_key, client, integration_key, service_id, service_key, api_key, desc

This module will let you trigger, acknowledge or resolve a PagerDuty incident by sending events

Pam Limits *arguments

Modify Linux PAM limits

Arguments: comment, use_max, domain, dest, value, use_min, limit_item, limit_type, backup

The C(pam_limits) module modifies PAM limits. The default file is C(/etc/security/limits.conf). For the full documentation, see C(man 5 limits.conf).

Pamd *arguments

Manage PAM Modules

Arguments: control, new_module_path, name, type, new_type, state, new_control, module_path, path, backup, module_arguments

Edit PAM service's type, control, module path and module arguments. In order for a PAM rule to be modified, the type, control and module_path must match an existing rule. See man(5) pam.d for details.

Parted *arguments

Configure block device partitions

Arguments: part_start, part_end, name, align, number, label, state, part_type, flags, device, unit

This module allows configuring block device partition using the C(parted) command line tool. For a full description of the fields and the options check the GNU parted manual.

Patch *arguments

Apply patch files using the GNU patch tool

Arguments: src, remote_src, dest, basedir, binary, state, strip, backup

Apply patch files using the GNU patch tool.

Pause *arguments

Pause playbook execution

Arguments: seconds, minutes, prompt, echo

Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to pause with a prompt. To pause/wait/sleep per host, use the M(wait_for) module. You can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early press C(ctrl+c) and then C(c). To abort a playbook press C(ctrl+c) and then C(a). The pause module integrates into async/parallelized playbooks without any special considerations (see Rolling Updates). When using pauses with the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts. This module is also supported for Windows targets.

Pear *arguments

Manage pear/pecl packages

Arguments: state, executable, name

Manage PHP packages with the pear package manager.

Picker w, *p
Pids *arguments

Retrieves process IDs list if the process is running otherwise return empty list

Arguments: name

Retrieves a list of PIDs of given process name in Ansible controller/controlled machines.Returns an empty list if no process in that name exists.

Ping *arguments

Try to connect to host, verify a usable python and return C(pong) on success

Arguments: data

A trivial test module, this module always returns C(pong) on successful contact. It does not make sense in playbooks, but it is useful from C(/usr/bin/ansible) to verify the ability to login and that a usable Python is configured. This is NOT ICMP ping, this is just a trivial test module that requires Python on the remote-node. For Windows targets, use the M(win_ping) module instead. For Network targets, use the M(net_ping) module instead.

Pingdom *arguments

Pause/unpause Pingdom alerts

Arguments: checkid, passwd, state, uid, key

This module will let you pause/unpause Pingdom alerts

Pip *arguments

Manages Python library dependencies

Arguments: virtualenv, virtualenv_site_packages, virtualenv_command, chdir, requirements, name, virtualenv_python, editable, umask, executable, extra_args, state, version

Manage Python library dependencies. To use this module, one of the following keys is required: C(name) or C(requirements).

Pip Package Info *arguments

pip package information

Arguments: clients

Return information about installed pip packages

Pkg 5 *arguments

Manages packages with the Solaris 11 Image Packaging System

Arguments: accept_licenses, state, be_name, name, refresh

IPS packages are the native packages in Solaris 11 and higher.

Pkg5 Publisher *arguments

Manages Solaris 11 Image Packaging System publishers

Arguments: origin, state, name, mirror, enabled, sticky

IPS packages are the native packages in Solaris 11 and higher. This modules will configure which publishers a client will download IPS packages from.

Pkgin *arguments

Package manager for SmartOS, NetBSD, et al.

Arguments: state, upgrade, force, name, full_upgrade, update_cache, clean

The standard package manager for SmartOS, but also usable on NetBSD or any OS that uses C(pkgsrc). (Home: U(http://pkgin.net/))

Pkgng *arguments

Package manager for FreeBSD >= 9.0

Arguments: chroot, name, cached, pkgsite, state, rootdir, autoremove, jail, annotation

Manage binary packages for FreeBSD using 'pkgng' which is available in versions after 9.0.

Pkgutil *arguments

Manage CSW-Packages on Solaris

Arguments: site, state, update_catalog, name

Manages CSW packages (SVR4 format) on Solaris 10 and 11. These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11. Pkgutil is an advanced packaging system, which resolves dependency on installation. It is designed for CSW packages.

Pn Access List *arguments

CLI command to create/delete access-list

Arguments: state, pn_name, pn_cliswitch, pn_scope

This module can be used to create and delete an access list.

Pn Access List Ip *arguments

CLI command to add/remove access-list-ip

Arguments: state, pn_name, pn_cliswitch, pn_ip

This modules can be used to add and remove IPs associated with access list.

Pn Admin Service *arguments

CLI command to modify admin-service

Arguments: pn_web_port, pn_web, pn_net_api, pn_web_ssl, pn__if, pn_icmp, state, pn_web_ssl_port, pn_nfs, pn_ssh, pn_web_log, pn_cliswitch, pn_snmp

This module is used to modify services on the server-switch.

Pn Admin Session Timeout *arguments

CLI command to modify admin-session-timeout

Arguments: state, pn_timeout, pn_cliswitch

This module can be used to modify admin session timeout.

Pn Admin Syslog *arguments

CLI command to create/modify/delete admin-syslog

Arguments: pn_name, pn_host, pn_scope, state, pn_message_format, pn_transport, pn_cliswitch, pn_port

This module can be used to create the scope and other parameters of syslog event collection. This module can be used to modify parameters of syslog event collection. This module can be used to delete the scope and other parameters of syslog event collection.

Pn Connection Stats Settings *arguments

CLI command to modify connection-stats-settings

Arguments: pn_connection_max_memory, pn_connection_backup_enable, pn_connection_backup_interval, pn_connection_stats_log_interval, pn_enable, pn_connection_stats_log_disk_space, pn_client_server_stats_log_enable, pn_client_server_stats_max_memory, pn_connection_stats_max_memory, pn_client_server_stats_log_interval, pn_fabric_connection_max_memory, state, pn_cliswitch, pn_service_stat_max_memory, pn_fabric_connection_backup_enable, pn_fabric_connection_backup_interval, pn_connection_stats_log_enable, pn_client_server_stats_log_disk_space

This module can be used to modify the settings for collecting statistical data about connections.

Pn Cpu Class *arguments

CLI command to create/modify/delete cpu-class

Arguments: pn_rate_limit, pn_name, pn_scope, pn_cliswitch, state, pn_hog_protect

This module can be used to create, modify and delete CPU class information.

Pn Cpu Mgmt Class *arguments

CLI command to modify cpu-mgmt-class

Arguments: state, pn_name, pn_cliswitch, pn_rate_limit, pn_burst_size

This module can we used to update mgmt port ingress policers.

Pn Dhcp Filter *arguments

CLI command to create/modify/delete dhcp-filter

Arguments: pn_trusted_ports, state, pn_name, pn_cliswitch

This module can be used to create, delete and modify a DHCP filter config.

Pn Dscp Map *arguments

CLI command to create/delete dscp-map

Arguments: state, pn_name, pn_cliswitch, pn_scope

This module can be used to create a DSCP priority mapping table.

Pn Dscp Map Pri Map *arguments

CLI command to modify dscp-map-pri-map

Arguments: pn_dsmap, pn_pri, pn_name, state, pn_cliswitch

This module can be used to update priority mappings in tables.

Pn Fabric Local *arguments

CLI command to modify fabric-local

Arguments: pn_fabric_advertisement_network, pn_fabric_network, state, pn_vlan, pn_control_network, pn_cliswitch

This module can be used to modify fabric local information.

Pn Igmp Snooping *arguments

CLI command to modify igmp-snooping

Arguments: pn_enable_vlans, pn_scope, pn_query_interval, pn_igmpv2_vlans, pn_query_max_response_time, pn_igmpv3_vlans, pn_enable, state, pn_no_snoop_linklocal_vlans, pn_vxlan, pn_cliswitch, pn_snoop_linklocal_vlans

This module can be used to modify Internet Group Management Protocol (IGMP) snooping.

Pn Ipv6security Raguard *arguments

CLI command to create/modify/delete ipv6security-raguard

Arguments: state, pn_name, pn_router_priority, pn_access_list, pn_prefix_list, pn_cliswitch, pn_device

This module can be used to add ipv6 RA Guard Policy, Update ipv6 RA guard Policy and Remove ipv6 RA Guard Policy.

Pn Ipv6security Raguard Port *arguments

CLI command to add/remove ipv6security-raguard-port

Arguments: pn_name, state, pn_ports, pn_cliswitch

This module can be used to add ports to RA Guard Policy and remove ports to RA Guard Policy.

Pn Ipv6security Raguard Vlan *arguments

CLI command to add/remove ipv6security-raguard-vlan

Arguments: state, pn_name, pn_cliswitch, pn_vlans

This module can be used to Add vlans to RA Guard Policy and Remove vlans to RA Guard Policy.

Pn Log Audit Exception *arguments

CLI command to create/delete an audit exception

Arguments: state, pn_access, pn_scope, pn_audit_type, pn_cliswitch, pn_pattern

This module can be used to create an audit exception and delete an audit exception.

Pn Port Config *arguments

CLI command to modify port-config

Arguments: pn_vxlan_termination, pn_allowed_tpid, pn_dscp_map, pn_loopback, pn_reflect, pn_egress_rate_limit, pn_enable, pn_port_mac_address, pn_autoneg, pn_crc_check_enable, pn_speed, pn_eth_mode, pn_description, pn_mirror_only, pn_intf, pn_send_port, pn_host_enable, pn_jumbo, pn_routing, pn_fabric_guard, pn_defer_bringup, pn_pause, pn_loop_vlans, state, pn_lacp_priority, pn_edge_switch, pn_port, pn_cliswitch, pn_local_switching

This module can be used to modify a port configuration.

Pn Port Cos Bw *arguments

CLI command to modify port-cos-bw

Arguments: pn_weight, state, pn_min_bw_guarantee, pn_cos, pn_max_bw_limit, pn_cliswitch, pn_port

This module can be used to update bw settings for CoS queues.

Pn Port Cos Rate Setting *arguments

CLI command to modify port-cos-rate-setting

Arguments: pn_cos0_rate, pn_cos3_rate, pn_cos7_rate, state, pn_cos2_rate, pn_cos4_rate, pn_cos1_rate, pn_cos6_rate, pn_cos5_rate, pn_cliswitch, pn_port

This modules can be used to update the port cos rate limit.

Pn Prefix List *arguments

CLI command to create/delete prefix-list

Arguments: state, pn_name, pn_cliswitch, pn_scope

This module can be used to create or delete prefix list.

Pn Prefix List Network *arguments

CLI command to add/remove prefix-list-network

Arguments: state, pn_name, pn_netmask, pn_cliswitch, pn_network

This module is used to add network associated with prefix list and remove networks associated with prefix list.

Pn Role *arguments

CLI command to create/delete/modify role

Arguments: pn_name, pn_access, pn_scope, pn_sudo, state, pn_shell, pn_delete_from_users, pn_cliswitch, pn_running_config

This module can be used to create, delete and modify user roles.

Pn Snmp Community *arguments

CLI command to create/modify/delete snmp-community

Arguments: state, pn_community_string, pn_cliswitch, pn_community_type

This module can be used to create SNMP communities for SNMPv1 or delete SNMP communities for SNMPv1 or modify SNMP communities for SNMPv1.

Pn Snmp Trap Sink *arguments

CLI command to create/delete snmp-trap-sink

Arguments: pn_dest_port, state, pn_community, pn_dest_host, pn_type, pn_cliswitch

This module can be used to create a SNMP trap sink and delete a SNMP trap sink.

Pn Snmp Vacm *arguments

CLI command to create/modify/delete snmp-vacm

Arguments: state, pn_auth, pn_user_type, pn_user_name, pn_cliswitch, pn_oid_restrict, pn_priv

This module can be used to create View Access Control Models (VACM), modify VACM and delete VACM.

Pn Stp *arguments

CLI command to modify stp

Arguments: pn_mst_max_hops, pn_bpdus_bridge_ports, pn_bridge_id, pn_root_guard_wait_time, pn_bridge_priority, pn_mst_config_name, pn_hello_time, pn_enable, state, pn_stp_mode, pn_forwarding_delay, pn_max_age, pn_cliswitch

This module can be used to modify Spanning Tree Protocol parameters.

Pn Stp Port *arguments

CLI command to modify stp-port.

Arguments: pn_bpdu_guard, pn_cost, pn_priority, state, pn_block, pn_edge, pn_filter, pn_cliswitch, pn_root_guard, pn_port

This module can be used modify Spanning Tree Protocol (STP) parameters on ports.

Pn Switch Setup *arguments

CLI command to modify switch-setup

Arguments: pn_ntp_secondary_server, pn_ntp_server, pn_dns_ip, pn_in_band_netmask_ip6, pn_eula_accepted, pn_in_band_ip6_assign, state, pn_in_band_ip6, pn_loopback_ip6, pn_banner, pn_timezone, pn_date, pn_mgmt_netmask_ip6, pn_mgmt_ip, pn_enable_host_ports, pn_mgmt_ip6_assignment, pn_switch_name, pn_loopback_ip, pn_motd, pn_force, pn_in_band_ip, pn_password, pn_domain_name, pn_gateway_ip6, pn_dns_secondary_ip, pn_analytics_store, pn_mgmt_netmask, pn_mgmt_ip_assignment, pn_in_band_netmask, pn_gateway_ip, pn_eula_timestamp, pn_mgmt_ip6, pn_cliswitch

This module can be used to modify switch setup.

Pn User *arguments

CLI command to create/modify/delete user

Arguments: state, pn_name, pn_initial_role, pn_scope, pn_password, pn_cliswitch

This module can be used to create a user and apply a role, update a user and delete a user.

Pn Vflow Table Profile *arguments

CLI command to modify vflow-table-profile

Arguments: pn_hw_tbl, pn_enable, state, pn_profile, pn_cliswitch

This module can be used to modify a vFlow table profile.

Pn Vrouter Bgp *arguments

CLI command to add/modify/remove vrouter-bgp

Arguments: pn_neighbor_holdtime, pn_prefix_list_out, pn_vrouter_name, pn_bfd_multihop, pn_route_map_out, pn_soft_reconfig_inbound, pn_bfd, pn_max_prefix_warn_only, pn_no_route_map_out, pn_route_reflector_client, state, pn_default_originate, pn_ebgp_multihop, pn_neighbor_keepalive_interval, pn_send_community, pn_advertisement_interval, pn_max_prefix, pn_update_source, pn_interface, pn_override_capability, pn_prefix_list_in, pn_multi_protocol, pn_connect_retry_interval, pn_password, pn_no_route_map_in, pn_neighbor, pn_allowas_in, pn_weight, pn_remote_as, pn_route_map_in, pn_cliswitch, pn_next_hop_self

This module can be used to add Border Gateway Protocol neighbor to a vRouter modify Border Gateway Protocol neighbor to a vRouter and remove Border Gateway Protocol neighbor from a vRouter.

Pn Vrouter Bgp Network *arguments

CLI command to add/remove vrouter-bgp-network

Arguments: state, pn_network, pn_netmask, pn_cliswitch, pn_vrouter_name

This module can be used to add Border Gateway Protocol network to a vRouter and remove Border Gateway Protocol network from a vRouter.

Pn Vrouter Interface Ip *arguments

CLI command to add/remove vrouter-interface-ip

Arguments: pn_bd, pn_ip, pn_vrouter_name, pn_vnet, state, pn_netmask, pn_nic, pn_cliswitch

This module can be used to add an IP address on interface from a vRouter or remove an IP address on interface from a vRouter.

Pn Vrouter Loopback Interface *arguments

CLI command to add/remove vrouter-loopback-interface

Arguments: state, pn_index, pn_ip, pn_cliswitch, pn_vrouter_name

This module can be used to add loopback interface to a vRouter or remove loopback interface from a vRouter.

Pn Vrouter Ospf *arguments

CLI command to add/remove vrouter-ospf

Arguments: state, pn_netmask, pn_vrouter_name, pn_ospf_area, pn_network, pn_cliswitch

This module can be used to add OSPF protocol to vRouter and remove OSPF protocol from a vRouter

Pn Vrouter Ospf6 *arguments

CLI command to add/remove vrouter-ospf6

Arguments: pn_vrouter_name, pn_ospf6_area, pn_nic, state, pn_cliswitch

This module can be used to add interface ip to OSPF6 protocol or remove interface ip from OSPF6 protocol on vRouter.

Pn Vrouter Packet Relay *arguments

CLI command to add/remove vrouter-packet-relay

Arguments: state, pn_nic, pn_vrouter_name, pn_forward_proto, pn_forward_ip, pn_cliswitch

This module can be used to add packet relay configuration for DHCP on vrouter and remove packet relay configuration for DHCP on vrouter.

Pn Vrouter Pim Config *arguments

CLI command to modify vrouter-pim-config

Arguments: pn_querier_timeout, pn_hello_interval, state, pn_vrouter_name, pn_query_interval, pn_cliswitch

This module can be used to modify pim parameters.

Pn Vtep *arguments

CLI command to create/delete vtep

Arguments: pn_switch_in_cluster, pn_name, pn_vrouter_name, pn_ip, pn_virtual_ip, state, pn_location, pn_cliswitch

This module can be used to create a vtep and delete a vtep.

Podman Image *arguments

Pull images for use by podman

Arguments: username, pull, executable, force, name, push_args, ca_cert_dir, state, tag, build, auth_file, push, path, password, validate_certs

Build, pull, or push images using Podman.

Podman Image Info *arguments

Gather info about images using podman

Arguments: executable, name

Gather info about images using C(podman)

Portage *arguments

Package manager for Gentoo

Arguments: nodeps, quietbuild, onlydeps, newuse, quietfail, oneshot, update, deep, sync, keepgoing, depclean, jobs, noreplace, loadavg, verbose, getbinpkg, package, quiet, state, changed_use, usepkgonly

Manages Gentoo packages

Portinstall *arguments

Installing packages from FreeBSD's ports system

Arguments: state, use_packages, name

Manage packages for FreeBSD using 'portinstall'.

Postgresql Copy *arguments

Copy data between a file/program and a PostgreSQL table

Arguments: src, dst, session_role, db, copy_from, program, columns, options, copy_to

Copy data between a file/program and a PostgreSQL table.

Postgresql Db *arguments

Add or remove PostgreSQL databases from a remote host.

Arguments: session_role, name, encoding, lc_collate, target_opts, lc_ctype, conn_limit, owner, state, tablespace, template, maintenance_db, port, target

Add or remove PostgreSQL databases from a remote host.

Postgresql Ext *arguments

Add or remove PostgreSQL extensions from a database

Arguments: ssl_mode, name, ca_cert, cascade, session_role, db, login_unix_socket, state, version, schema

Add or remove PostgreSQL extensions from a database.

Postgresql Idx *arguments

Create or drop indexes from a PostgreSQL database

Arguments: idxname, storage_params, concurrent, session_role, db, cascade, state, tablespace, table, cond, idxtype, columns, schema

Create or drop indexes from a PostgreSQL database.

Postgresql Info *arguments

Gather information about PostgreSQL servers

Arguments: filter, session_role, db

Gathers information about PostgreSQL servers.

Postgresql Lang *arguments

Adds, removes or changes procedural languages with a PostgreSQL database

Arguments: lang, ssl_mode, force_trust, ca_cert, cascade, session_role, db, login_unix_socket, state, trust, fail_on_drop

Adds, removes or changes procedural languages with a PostgreSQL database. This module allows you to add a language, remote a language or change the trust relationship with a PostgreSQL database. The module can be used on the machine where executed or on a remote host. When removing a language from a database, it is possible that dependencies prevent the database from being removed. In that case, you can specify I(cascade=yes) to automatically drop objects that depend on the language (such as functions in the language). In case the language can't be deleted because it is required by the database system, you can specify I(fail_on_drop=no) to ignore the error. Be careful when marking a language as trusted since this could be a potential security breach. Untrusted languages allow only users with the PostgreSQL superuser privilege to use this language to create new functions.

Postgresql Membership *arguments

Add or remove PostgreSQL roles from groups

Arguments: state, fail_on_role, groups, session_role, db, target_roles

Adds or removes PostgreSQL roles from groups (other roles). Users are roles with login privilege. Groups are PostgreSQL roles usually without LOGIN privilege. Common use case: 1) add a new group (groups) by M(postgresql_user) module with I(role_attr_flags=NOLOGIN) 2) grant them desired privileges by M(postgresql_privs) module 3) add desired PostgreSQL users to the new group (groups) by this module

Postgresql Owner *arguments

Change an owner of PostgreSQL database object

Arguments: obj_type, reassign_owned_by, fail_on_role, obj_name, new_owner, db, session_role

Change an owner of PostgreSQL database object. Also allows to reassign the ownership of database objects owned by a database role to another role.

Postgresql Pg Hba *arguments

Add, remove or modify a rule in a pg_hba file

Arguments: backup_file, users, dest, create, databases, netmask, order, method, state, contype, address, backup, options

The fundamental function of the module is to create, or delete lines in pg_hba files. The lines in the file should be in a typical pg_hba form and lines should be unique per key (type, databases, users, source). If they are not unique and the SID is 'the one to change', only one for C(state=present) or none for C(state=absent) of the SID's will remain.

Postgresql Ping *arguments

Check remote PostgreSQL server availability

Arguments: db

Simple module to check remote PostgreSQL server availability.

Postgresql Privs *arguments

Grant or revoke privileges on PostgreSQL database objects

Arguments: objs, ssl_mode, ca_cert, database, host, password, port, grant_option, roles, privs, session_role, target_roles, unix_socket, state, login, fail_on_role, type, schema

Grant or revoke privileges on PostgreSQL database objects. This module is basically a wrapper around most of the functionality of PostgreSQL's GRANT and REVOKE statements with detection of changes (GRANT/REVOKE I(privs) ON I(type) I(objs) TO/FROM I(roles)).

Postgresql Publication *arguments

Add, update, or remove PostgreSQL publication

Arguments: tables, state, name, parameters, cascade, owner, db

Add, update, or remove PostgreSQL publication.

Postgresql Query *arguments

Run PostgreSQL queries

Arguments: autocommit, path_to_script, named_args, query, session_role, db, positional_args

Runs arbitrary PostgreSQL queries. Can run queries from SQL script files. Does not run against backup files. Use M(postgresql_db) with I(state=restore) to run queries on files made by pg_dump/pg_dumpall utilities.

Postgresql Schema *arguments

Add or remove PostgreSQL schema

Arguments: ssl_mode, name, ca_cert, database, session_role, state, cascade_drop, owner

Add or remove PostgreSQL schema.

Postgresql Sequence *arguments

Create, drop, or alter a PostgreSQL sequence

Arguments: cache, data_type, sequence, db, increment, owner, rename_to, cascade, session_role, maxvalue, minvalue, start, state, newschema, cycle, schema

Allows to create, drop or change the definition of a sequence generator.

Postgresql Set *arguments

Change a PostgreSQL server configuration parameter

Arguments: reset, session_role, db, name, value

Allows to change a PostgreSQL server configuration parameter. The module uses ALTER SYSTEM command and applies changes by reload server configuration. ALTER SYSTEM is used for changing server configuration parameters across the entire database cluster. It can be more convenient and safe than the traditional method of manually editing the postgresql.conf file. ALTER SYSTEM writes the given parameter setting to the $PGDATA/postgresql.auto.conf file, which is read in addition to postgresql.conf. The module allows to reset parameter to boot_val (cluster initial value) by I(reset=yes) or remove parameter string from postgresql.auto.conf and reload I(value=default) (for settings with postmaster context restart is required). After change you can see in the ansible output the previous and the new parameter value and other information using returned values and M(debug) module.

Postgresql Slot *arguments

Add or remove replication slots from a PostgreSQL database

Arguments: state, name, output_plugin, immediately_reserve, session_role, db, slot_type

Add or remove physical or logical replication slots from a PostgreSQL database.

Postgresql Table *arguments

Create, drop, or modify a PostgreSQL table

Arguments: rename, like, truncate, unlogged, session_role, db, cascade, state, including, storage_params, owner, tablespace, table, columns

Allows to create, drop, rename, truncate a table, or change some table attributes.

Postgresql Tablespace *arguments

Add or remove PostgreSQL tablespaces from remote hosts

Arguments: set, session_role, db, state, tablespace, location, owner, rename_to

Adds or removes PostgreSQL tablespaces from remote hosts.

Postgresql User *arguments

Add or remove a user (role) from a PostgreSQL server instance

Arguments: session_role, ssl_mode, name, no_password_changes, encrypted, expires, db, conn_limit, state, groups, ca_cert, password, role_attr_flags, fail_on_user, priv

Adds or removes a user (role) from a PostgreSQL server instance ("cluster" in PostgreSQL terminology) and, optionally, grants the user access to an existing database or tables. A user is a role with login privilege. The fundamental function of the module is to create, or delete, users from a PostgreSQL instances. Privilege assignment, or removal, is an optional step, which works on one database at a time. This allows for the module to be called several times in the same module to modify the permissions on different databases, or to grant permissions to already existing users. A user cannot be removed until all the privileges have been stripped from the user. In such situation, if the module tries to remove the user it will fail. To avoid this from happening the fail_on_user option signals the module to try to remove the user, but if not possible keep going; the module will report if changes happened and separately if the user was removed or not.

Profitbricks *arguments

Create, destroy, start, stop, and reboot a ProfitBricks virtual machine.

Arguments: lan, image_password, bus, image, ram, instance_ids, subscription_password, wait_timeout, assign_public_ip, wait, count, datacenter, remove_boot_volume, ssh_keys, subscription_user, cpu_family, name, volume_size, state, location, auto_increment, cores

Create, destroy, update, start, stop, and reboot a ProfitBricks virtual machine. When the virtual machine is created it can optionally wait for it to be 'running' before returning. This module has a dependency on profitbricks >= 1.0.0

Profitbricks Datacenter *arguments

Create or destroy a ProfitBricks Virtual Datacenter.

Arguments: name, subscription_user, subscription_password, state, wait_timeout, location, wait, description

This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. This module has a dependency on profitbricks >= 1.0.0

Profitbricks Nic *arguments

Create or Remove a NIC.

Arguments: datacenter, lan, name, subscription_user, server, subscription_password, state, wait_timeout, wait

This module allows you to create or restore a volume snapshot. This module has a dependency on profitbricks >= 1.0.0

Profitbricks Volume *arguments

Create or destroy a volume.

Arguments: image_password, licence_type, bus, image, instance_ids, subscription_password, wait_timeout, disk_type, wait, count, datacenter, name, subscription_user, state, auto_increment, size, ssh_keys

Allows you to create or remove a volume from a ProfitBricks datacenter. This module has a dependency on profitbricks >= 1.0.0

Profitbricks Volume Attachments *arguments

Attach or detach a volume.

Arguments: datacenter, subscription_user, server, volume, state, wait_timeout, subscription_password, wait

Allows you to attach or detach a volume from a ProfitBricks server. This module has a dependency on profitbricks >= 1.0.0

Proxmox *arguments

management of instances in Proxmox VE cluster

Arguments: node, force, cpuunits, vmid, api_password, cpus, ostemplate, unprivileged, disk, ip_address, pool, api_host, password, searchdomain, netif, api_user, validate_certs, hostname, storage, state, swap, timeout, memory, mounts, cores, nameserver, pubkey, onboot

allows you to create/delete/stop instances in Proxmox VE cluster Starting in Ansible 2.1, it automatically detects containerization type (lxc for PVE 4, openvz for older)

Proxmox Kvm *arguments

Management of Qemu(KVM) Virtual Machines in Proxmox VE cluster.

Arguments: revert, boot, migrate_speed, vga, keyboard, watchdog, sockets, digest, tablet, bios, hostpci, autostart, memory, migrate_downtime, localtime, virtio, format, snapname, hotplug, name, target, vmid, bootdisk, vcpus, newid, timeout, skiplock, validate_certs, onboot, delete, force, lock, startup, agent, freeze, serial, startdate, balloon, cpuunits, storage, reboot, shares, machine, sata, state, template, net, acpi, node, full, description, scsihw, clone, args, api_password, tdf, update, kvm, ostype, protection, numa, parallel, pool, api_host, cpulimit, api_user, hugepages, smbios, cores, scsi, ide, cpu

Allows you to create/delete/stop Qemu(KVM) Virtual Machines in Proxmox VE cluster.

Proxmox Template *arguments

management of OS templates in Proxmox VE cluster

Arguments: node, src, force, api_host, api_user, api_password, storage, state, content_type, timeout, validate_certs, template

allows you to upload/delete templates in Proxmox VE cluster

Proxysql Backend Servers *arguments

Adds or removes mysql hosts from proxysql admin interface.

Arguments: status, comment, compression, weight, hostname, hostgroup_id, state, use_ssl, max_connections, port, max_latency_ms, max_replication_lag

The M(proxysql_backend_servers) module adds or removes mysql hosts using the proxysql admin interface.

Proxysql Global Variables *arguments

Gets or sets the proxysql global variables.

Arguments: variable, value

The M(proxysql_global_variables) module gets or sets the proxysql global variables.

Proxysql Manage Config *arguments

Writes the proxysql configuration settings between layers.

Arguments: action, config_layer, direction, config_settings

The M(proxysql_global_variables) module writes the proxysql configuration settings between layers. Currently this module will always report a changed state, so should typically be used with WHEN however this will change in a future version when the CHECKSUM table commands are available for all tables in proxysql.

Proxysql Mysql Users *arguments

Adds or removes mysql users from proxysql admin interface.

Arguments: username, default_hostgroup, frontend, default_schema, transaction_persistent, backend, state, fast_forward, active, use_ssl, password, max_connections

The M(proxysql_mysql_users) module adds or removes mysql users using the proxysql admin interface.

Proxysql Query Rules *arguments

Modifies query rules using the proxysql admin interface.

Arguments: comment, username, flagOUT, match_pattern, destination_hostgroup, proxy_port, active, mirror_flagOUT, apply, schemaname, replace_pattern, cache_ttl, digest, retries, match_digest, mirror_hostgroup, log, negate_match_pattern, flagIN, client_addr, error_msg, delay, state, proxy_addr, timeout, force_delete, rule_id

The M(proxysql_query_rules) module modifies query rules using the proxysql admin interface.

Proxysql Replication Hostgroups *arguments

Manages replication hostgroups using the proxysql admin interface.

Arguments: comment, state, reader_hostgroup, writer_hostgroup

Each row in mysql_replication_hostgroups represent a pair of writer_hostgroup and reader_hostgroup. ProxySQL will monitor the value of read_only for all the servers in specified hostgroups, and based on the value of read_only will assign the server to the writer or reader hostgroups.

Proxysql Scheduler *arguments

Adds or removes schedules from proxysql admin interface.

Arguments: comment, arg1, arg2, arg3, arg4, arg5, filename, state, interval_ms, force_delete, active

The M(proxysql_scheduler) module adds or removes schedules using the proxysql admin interface.

Psexec *arguments

Runs commands on a remote Windows host based on the PsExec model

Arguments: stdin, show_ui_on_logon_screen, connection_password, load_profile, integrity_level, connection_username, working_directory, process_username, process_password, process_timeout, connection_timeout, port, executable, encrypt, interactive_session, hostname, priority, arguments, asynchronous, interactive

Runs a remote command from a Linux host to a Windows host without WinRM being set up. Can be run on the Ansible controller to bootstrap Windows hosts to get them ready for WinRM.

Pubnub Blocks *arguments

PubNub blocks management module.

Arguments: account, name, keyset, changes, cache, application, state, password, validate_certs, email, event_handlers, description

This module allows Ansible to interface with the PubNub BLOCKS infrastructure by providing the following operations: create / remove, start / stop and rename for blocks and create / modify / remove for event handlers

Pulp Repo *arguments

Add or remove Pulp repos from a remote host.

Arguments: feed, repo_type, pulp_host, feed_client_key, relative_url, force_basic_auth, feed_ca_cert, proxy_password, proxy_port, serve_http, wait_for_completion, add_export_distributor, url_password, publish_distributor, name, proxy_host, generate_sqlite, feed_client_cert, state, serve_https, proxy_username, url_username, validate_certs, repoview

Add or remove Pulp repos from a remote host.

Puppet *arguments

Runs puppet

Arguments: facter_basename, verbose, tags, certname, facts, summarize, use_srv_records, modulepath, logdest, execute, puppetmaster, manifest, environment, noop, timeout, debug

Runs I(puppet) agent or apply in a reliable manner.

Purefa Alert *arguments

Configure Pure Storage FlashArray alert email settings

Arguments: state, enabled, address

Configure alert email configuration for Pure Storage FlashArrays. Add or delete an individual syslog server to the existing list of serves.

Purefa Arrayname *arguments

Configure Pure Storage FlashArray array name

Arguments: state, name

Configure name of array for Pure Storage FlashArrays. Ideal for Day 0 initial configuration.

Purefa Banner *arguments

Configure Pure Storage FlashArray GUI and SSH MOTD message

Arguments: state, banner

Configure MOTD for Pure Storage FlashArrays. This will be shown during an SSH or GUI login to the array. Multiple line messages can be achieved using \\n.

Purefa Connect *arguments

Manage replication connections between two FlashArrays

Arguments: target_api, state, target_url, connection

Manage array connections to specified target array

Purefa Dns *arguments

Configure FlashArray DNS settings

Arguments: nameservers, state, domain

Set or erase configuration for the DNS settings. Nameservers provided will overwrite any existing nameservers.

Purefa Ds *arguments

Configure FlashArray Directory Service

Arguments: bind_user, group_base, enable, uri, aa_group, ro_group, state, bind_password, base_dn, sa_group

Set or erase configuration for the directory service. There is no facility to SSL certificates at this time. Use the FlashArray GUI for this additional configuration work. To modify an existing directory service configuration you must first delete an existing configuration and then recreate with new settings.

Purefa Dsrole *arguments

Configure FlashArray Directory Service Roles

Arguments: group_base, state, role, group

Set or erase directory services role configurations. Only available for FlashArray running Purity 5.2.0 or higher

Purefa Hg *arguments

Manage hostgroups on Pure Storage FlashArrays

Arguments: volume, state, host, hostgroup

Create, delete or modify hostgroups on Pure Storage FlashArrays.

Purefa Host *arguments

Manage hosts on Pure Storage FlashArrays

Arguments: preferred_array, protocol, host, volume, state, iqn, wwns, nqn, lun, personality

Create, delete or modify hosts on Pure Storage FlashArrays.

Purefa Info *arguments

Collect information from Pure Storage FlashArray

Arguments: gather_subset

Collect information from a Pure Storage Flasharray running the Purity//FA operating system. By default, the module will collect basic information including hosts, host groups, protection groups and volume counts. Additional information can be collected based on the configured set of arguments.

Purefa Ntp *arguments

Configure Pure Storage FlashArray NTP settings

Arguments: ntp_servers, state

Set or erase NTP configuration for Pure Storage FlashArrays.

Purefa Offload *arguments

Create, modify and delete NFS or S3 offload targets

Arguments: access_key, protocol, name, share, bucket, state, secret, address, initialize, options

Create, modify and delete NFS or S3 offload targets. Only supported on Purity v5.2.0 or higher. You must have a correctly configured offload network for offload to work.

Purefa Pg *arguments

Manage protection groups on Pure Storage FlashArrays

Arguments: target, enabled, state, hostgroup, volume, host, pgroup, eradicate

Create, delete or modify protection groups on Pure Storage FlashArrays. If a protection group exists and you try to add non-valid types, eg. a host to a volume protection group the module will ignore the invalid types. Protection Groups on Offload targets are supported.

Purefa Pgsnap *arguments

Manage protection group snapshots on Pure Storage FlashArrays

Arguments: apply_retention, restore, remote, name, eradicate, state, target, now, overwrite, suffix

Create or delete protection group snapshots on Pure Storage FlashArray. Recovery of replicated snapshots on the replica target array is enabled.

Purefa Phonehome *arguments

Enable or Disable Pure Storage FlashArray Phonehome

Arguments: state

Enable or Disable Phonehome for a Pure Storage FlashArray.

Purefa Ra *arguments

Enable or Disable Pure Storage FlashArray Remote Assist

Arguments: state

Enable or Disable Remote Assist for a Pure Storage FlashArray.

Purefa Smtp *arguments

Configure FlashArray SMTP settings

Arguments: state, password, user, relay_host, sender_domain

Set or erase configuration for the SMTP settings. If username/password are set this will always force a change as there is no way to see if the password is different from the current SMTP configuration. Pure Storage Ansible Team (@sdodsley) <pure-ansible-team@purestorage.com>

Purefa Snap *arguments

Manage volume snapshots on Pure Storage FlashArrays

Arguments: state, suffix, target, eradicate, overwrite, name

Create or delete volumes and volume snapshots on Pure Storage FlashArray.

Purefa Snmp *arguments

Configure FlashArray SNMP Managers

Arguments: name, notification, state, community, privacy_protocol, auth_protocol, host, version, user, privacy_passphrase, auth_passphrase

Manage SNMP managers on a Pure Storage FlashArray. Changing of a named SNMP managers version is not supported. This module is not idempotent and will always modify an existing SNMP manager due to hidden parameters that cannot be compared to the play parameters.

Purefa Syslog *arguments

Configure Pure Storage FlashArray syslog settings

Arguments: state, protocol, port, address

Configure syslog configuration for Pure Storage FlashArrays. Add or delete an individual syslog server to the existing list of serves.

Purefa User *arguments

Create, modify or delete FlashArray local user account

Arguments: state, api, role, name, password, old_password

Create, modify or delete local users on a Pure Storage FlashArray.

Purefa Vg *arguments

Manage volume groups on Pure Storage FlashArrays

Arguments: vgroup, state, eradicate

Create, delete or modify volume groups on Pure Storage FlashArrays.

Purefa Volume *arguments

Manage volumes on Pure Storage FlashArrays

Arguments: size, state, qos, name, eradicate, overwrite, target

Create, delete or extend the capacity of a volume on Pure Storage FlashArray.

Purefb Bucket *arguments

Manage Object Store Buckets on a Pure Storage FlashBlade.

Arguments: account, state, name, eradicate

This module managess object store (s3) buckets on Pure Storage FlashBlade.

Purefb Ds *arguments

Configure FlashBlade Directory Service

Arguments: bind_user, dstype, enable, join_ou, nis_domain, uri, state, bind_password, base_dn, nis_servers

Create or erase directory services configurations. There is no facility to SSL certificates at this time. Use the FlashBlade GUI for this additional configuration work. To modify an existing directory service configuration you must first delete an existing configuration and then recreate with new settings.

Purefb Dsrole *arguments

Configure FlashBlade Management Directory Service Roles

Arguments: group_base, state, role, group

Set or erase directory services role configurations.

Purefb Fs *arguments

Manage filesystemon Pure Storage FlashBlade`

Arguments: snapshot, smb, nfs_rules, http, name, nfsv4, size, group_quota, state, nfs, fastremove, nfsv3, hard_limit, user_quota, eradicate

This module manages filesystems on Pure Storage FlashBlade.

Purefb Info *arguments

Collect information from Pure Storage FlashBlade

Arguments: gather_subset

Collect information from a Pure Storage FlashBlade running the Purity//FB operating system. By default, the module will collect basic information including hosts, host groups, protection groups and volume counts. Additional information can be collected based on the configured set of arguments.

Purefb Network *arguments

Manage network interfaces in a Pure Storage FlashBlade

Arguments: services, state, itype, name, address

This module manages network interfaces on Pure Storage FlashBlade. When creating a network interface a subnet must already exist with a network prefix that covers the IP address of the interface being created.

Purefb Ra *arguments

Enable or Disable Pure Storage FlashBlade Remote Assist

Arguments: state

Enable or Disable Remote Assist for a Pure Storage FlashBlade.

Purefb S3acc *arguments

Create or delete FlashBlade Object Store accounts

Arguments: state, name

Create or delete object store accounts on a Pure Storage FlashBlade.

Purefb S3user *arguments

Create or delete FlashBlade Object Store account users

Arguments: access_key, account, state, name

Create or delete object store account users on a Pure Storage FlashBlade.

Purefb Smtp *arguments

Configure SMTP for Pure Storage FlashBlade

Arguments: host, domain

Configure SMTP for a Pure Storage FlashBlade. Whilst there can be no relay host, a sender domain must be configured.

Purefb Snap *arguments

Manage filesystem snapshots on Pure Storage FlashBlades

Arguments: state, suffix, name, eradicate

Create or delete volumes and filesystem snapshots on Pure Storage FlashBlades.

Purefb Subnet *arguments

Manage network subnets in a Pure Storage FlashBlade

Arguments: state, gateway, name, vlan, prefix, mtu

This module manages network subnets on Pure Storage FlashBlade.

Pushbullet *arguments

Sends notifications to Pushbullet

Arguments: body, title, device, push_type, api_key, channel

This module sends push notifications via Pushbullet to channels or devices.

Pushover *arguments

Send notifications via U(https://pushover.net)

Arguments: msg, user_key, app_token, pri, title

Send notifications via pushover, to subscriber list of devices, and email addresses. Requires pushover app on devices.

Python Requirements Info *arguments

Show python path and assert dependency versions

Arguments: dependencies

Get info about available Python requirements on the target host, including listing required libraries and gathering versions. This module was called C(python_requirements_facts) before Ansible 2.9. The usage did not change.

Rabbitmq Binding *arguments

Manage rabbitMQ bindings

Arguments: state, name, destination_type, destination, routing_key, arguments

This module uses rabbitMQ REST APIs to create / delete bindings.

Rabbitmq Exchange *arguments

Manage rabbitMQ exchanges

Arguments: state, internal, name, arguments, durable, auto_delete, exchange_type

This module uses rabbitMQ Rest API to create/delete exchanges

Rabbitmq Global Parameter *arguments

Manage RabbitMQ global parameters

Arguments: node, state, name, value

Manage dynamic, cluster-wide global parameters for RabbitMQ

Rabbitmq Parameter *arguments

Manage RabbitMQ parameters

Arguments: node, vhost, state, name, component, value

Manage dynamic, cluster-wide parameters for RabbitMQ

Rabbitmq Plugin *arguments

Manage RabbitMQ plugins

Arguments: state, new_only, prefix, names

This module can be used to enable or disable RabbitMQ plugins.

Rabbitmq Policy *arguments

Manage the state of policies in RabbitMQ

Arguments: node, name, tags, pattern, priority, vhost, state, apply_to

Manage the state of a policy in RabbitMQ.

Rabbitmq Publish *arguments

Publish a message to a RabbitMQ queue.

Arguments: username, body, exchange, auto_delete, vhost, host, content_type, password, port, src, proto, url, durable, routing_key, queue, headers, exclusive

Publish a message on a RabbitMQ queue using a blocking connection.

Rabbitmq Queue *arguments

Manage rabbitMQ queues

Arguments: dead_letter_exchange, name, durable, state, max_length, arguments, message_ttl, auto_expires, dead_letter_routing_key, auto_delete, max_priority

This module uses rabbitMQ Rest API to create/delete queues

Rabbitmq User *arguments

Manage RabbitMQ users

Arguments: node, update_password, force, tags, read_priv, write_priv, state, user, configure_priv, vhost, password, permissions

Add or remove users to RabbitMQ and assign permissions

Rabbitmq Vhost *arguments

Manage the state of a virtual host in RabbitMQ

Arguments: node, tracing, state, name

Manage the state of a virtual host in RabbitMQ

Rabbitmq Vhost Limits *arguments

Manage the state of virtual host limits in RabbitMQ

Arguments: node, vhost, state, max_queues, max_connections

This module sets/clears certain limits on a virtual host. The configurable limits are I(max_connections) and I(max-queues).

Raw *arguments

Executes a low-down and dirty command

Arguments: free_form, executable

Executes a low-down and dirty SSH command, not going through the module subsystem. This is useful and should only be done in a few cases. A common case is installing C(python) on a system without python installed by default. Another is speaking to any devices such as routers that do not have any Python installed. In any other case, using the M(shell) or M(command) module is much more appropriate. Arguments given to C(raw) are run directly through the configured remote shell. Standard output, error output and return code are returned when available. There is no change handler support for this module. This module does not require python on the remote system, much like the M(script) module. This module is also supported for Windows targets.

Rax *arguments

create / delete an instance in Rackspace Public Cloud

Arguments: files, boot_volume_terminate, auto_increment, image, user_data, boot_volume, count_offset, meta, instance_ids, flavor, networks, wait, boot_from_volume, group, name, extra_client_args, exact_count, disk_config, count, state, wait_timeout, key_name, boot_volume_size, extra_create_args, config_drive

creates / deletes a Rackspace Public Cloud instance and optionally waits for it to be 'running'.

Rax Cbs *arguments

Manipulate Rackspace Cloud Block Storage Volumes

Arguments: size, description, image, volume_type, state, meta, snapshot_id, wait, wait_timeout, name

Manipulate Rackspace Cloud Block Storage Volumes

Rax Cbs Attachments *arguments

Manipulate Rackspace Cloud Block Storage Volume Attachments

Arguments: volume, state, wait_timeout, device, wait, server

Manipulate Rackspace Cloud Block Storage Volume Attachments

Rax Cdb *arguments

create/delete or resize a Rackspace Cloud Databases instance

Arguments: cdb_type, name, cdb_version, volume, state, wait_timeout, flavor, wait

creates / deletes or resize a Rackspace Cloud Databases instance and optionally waits for it to be 'running'. The name option needs to be unique since it's used to identify the instance.

Rax Cdb Database *arguments

create / delete a database in the Cloud Databases

Arguments: cdb_id, state, character_set, collate, name

create / delete a database in the Cloud Databases.

Rax Cdb User *arguments

create / delete a Rackspace Cloud Database

Arguments: state, db_username, db_password, cdb_id, databases, host

create / delete a database in the Cloud Databases.

Rax Clb *arguments

create / delete a load balancer in Rackspace Public Cloud

Arguments: protocol, name, algorithm, vip_id, state, wait_timeout, meta, timeout, type, port, wait

creates / deletes a Rackspace Public Cloud load balancer.

Rax Clb Nodes *arguments

add, modify and remove nodes from a Rackspace Cloud Load Balancer

Arguments: weight, load_balancer_id, state, wait_timeout, condition, address, type, port, node_id, wait

Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer

Rax Clb Ssl *arguments

Manage SSL termination for a Rackspace Cloud Load Balancer.

Arguments: private_key, certificate, enabled, https_redirect, state, wait_timeout, intermediate_certificate, secure_traffic_only, secure_port, loadbalancer, wait

Set up, reconfigure, or remove SSL termination for an existing load balancer.

Rax Dns *arguments

Manage domains on Rackspace Cloud DNS

Arguments: comment, state, email, name, ttl

Manage domains on Rackspace Cloud DNS

Rax Dns Record *arguments

Manage DNS records on Rackspace Cloud DNS

Arguments: comment, domain, name, data, server, priority, state, loadbalancer, ttl, type, overwrite

Manage DNS records on Rackspace Cloud DNS

Rax Facts *arguments

Gather facts for Rackspace Cloud Servers

Arguments: address, id, name

Gather facts for Rackspace Cloud Servers.

Rax Files *arguments

Manipulate Rackspace Cloud Files Containers

Arguments: web_index, container, region, private, state, clear_meta, meta, ttl, web_error, type, public

Manipulate Rackspace Cloud Files Containers

Rax Files Objects *arguments

Upload, download, and delete objects in Rackspace Cloud Files

Arguments: src, container, dest, expires, state, clear_meta, meta, type, method, structure

Upload, download, and delete objects in Rackspace Cloud Files

Rax Identity *arguments

Load Rackspace Cloud Identity

Arguments: state

Verifies Rackspace Cloud credentials and returns identity information

Rax Keypair *arguments

Create a keypair for use with Rackspace Cloud Servers

Arguments: public_key, state, name

Create a keypair for use with Rackspace Cloud Servers

Rax Meta *arguments

Manipulate metadata for Rackspace Cloud Servers

Arguments: meta, id, address, name

Manipulate metadata for Rackspace Cloud Servers

Rax Mon Alarm *arguments

Create or delete a Rackspace Cloud Monitoring alarm.

Arguments: entity_id, notification_plan_id, check_id, label, disabled, state, criteria, metadata

Create or delete a Rackspace Cloud Monitoring alarm that associates an existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with criteria that specify what conditions will trigger which levels of notifications. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Rax Mon Check *arguments

Create or delete a Rackspace Cloud Monitoring check for an existing entity.

Arguments: entity_id, check_type, target_alias, state, label, disabled, target_hostname, period, details, timeout, monitoring_zones_poll, metadata

Create or delete a Rackspace Cloud Monitoring check associated with an existing rax_mon_entity. A check is a specific test or measurement that is performed, possibly from different monitoring zones, on the systems you monitor. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Rax Mon Entity *arguments

Create or delete a Rackspace Cloud Monitoring entity

Arguments: state, label, agent_id, named_ip_addresses, metadata

Create or delete a Rackspace Cloud Monitoring entity, which represents a device to monitor. Entities associate checks and alarms with a target system and provide a convenient, centralized place to store IP addresses. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Rax Mon Notification *arguments

Create or delete a Rackspace Cloud Monitoring notification.

Arguments: notification_type, state, details, label

Create or delete a Rackspace Cloud Monitoring notification that specifies a channel that can be used to communicate alarms, such as email, webhooks, or PagerDuty. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Rax Mon Notification Plan *arguments

Create or delete a Rackspace Cloud Monitoring notification plan.

Arguments: ok_state, state, warning_state, critical_state, label

Create or delete a Rackspace Cloud Monitoring notification plan by associating existing rax_mon_notifications with severity levels. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm

Rax Network *arguments

create / delete an isolated network in Rackspace Public Cloud

Arguments: state, cidr, label

creates / deletes a Rackspace Public Cloud isolated network.

Rax Queue *arguments

create / delete a queue in Rackspace Public Cloud

Arguments: state, name

creates / deletes a Rackspace Public Cloud queue.

Rax Scaling Group *arguments

Manipulate Rackspace Cloud Autoscale Groups

Arguments: files, key_name, image, user_data, min_entities, cooldown, flavor, networks, wait, max_entities, name, server_name, loadbalancers, wait_timeout, disk_config, state, meta, config_drive

Manipulate Rackspace Cloud Autoscale Groups

Rax Scaling Policy *arguments

Manipulate Rackspace Cloud Autoscale Scaling Policy

Arguments: is_percent, name, scaling_group, cron, desired_capacity, state, cooldown, at, policy_type, change

Manipulate Rackspace Cloud Autoscale Scaling Policy

Rds *arguments

create, delete, or modify Amazon rds instances, rds snapshots, and related facts

Arguments: db_engine, iops, backup_window, backup_retention, port, security_groups, size, aws_secret_key, subnet, vpc_security_groups, upgrade, zone, instance_type, source_instance, parameter_group, command, multi_zone, new_instance_name, username, tags, db_name, license_model, password, apply_immediately, wait, aws_access_key, character_set_name, region, option_group, engine_version, instance_name, force_failover, wait_timeout, snapshot, publicly_accessible, maint_window

Creates, deletes, or modifies rds resources. When creating an instance it can be either a new instance or a read-only replica of an existing instance. This module has a dependency on python-boto >= 2.5 and will soon be deprecated. The 'promote' command requires boto >= 2.18.0. Certain features such as tags rely on boto.rds2 (boto >= 2.26.0). Please use boto3 based M(rds_instance) instead.

Rds Instance *arguments

Manage RDS instances

Arguments: backup_retention_period, source_db_instance_identifier, availability_zone, s3_bucket_name, db_instance_class, storage_type, iops, db_security_groups, master_username, snapshot_identifier, db_instance_identifier, performance_insights_retention_period, state, timezone, tde_credential_password, read_replica, source_engine, preferred_backup_window, creation_source, max_allocated_storage, enable_iam_database_authentication, db_snapshot_identifier, engine, db_parameter_group_name, enable_cloudwatch_logs_exports, ca_certificate_identifier, db_name, copy_tags_to_snapshot, skip_final_snapshot, character_set_name, multi_az, source_engine_version, db_subnet_group_name, restore_time, auto_minor_version_upgrade, domain, force_update_password, s3_ingestion_role_arn, purge_tags, kms_key_id, publicly_accessible, domain_iam_role_name, use_latest_restorable_time, port, new_db_instance_identifier, enable_performance_insights, allocated_storage, final_db_snapshot_identifier, monitoring_role_arn, vpc_security_group_ids, promotion_tier, db_cluster_identifier, tags, allow_major_version_upgrade, license_model, storage_encrypted, purge_cloudwatch_logs_exports, performance_insights_kms_key_id, apply_immediately, wait, force_failover, master_user_password, engine_version, option_group_name, processor_features, source_region, s3_prefix, preferred_maintenance_window, monitoring_interval, tde_credential_arn

Create, modify, and delete RDS instances.

Rds Instance Info *arguments

obtain information about one or more RDS instances

Arguments: db_instance_identifier, filters

obtain information about one or more RDS instances This module was called C(rds_instance_facts) before Ansible 2.9. The usage did not change.

Rds Param Group *arguments

manage RDS parameter groups

Arguments: engine, name, tags, purge_tags, immediate, state, params, description

Creates, modifies, and deletes RDS parameter groups. This module has a dependency on python-boto >= 2.5.

Rds Snapshot *arguments

manage Amazon RDS snapshots.

Arguments: db_instance_identifier, state, wait_timeout, tags, purge_tags, wait, db_snapshot_identifier

Creates or deletes RDS snapshots.

Rds Snapshot Info *arguments

obtain information about one or more RDS snapshots

Arguments: db_instance_identifier, db_cluster_snapshot_identifier, db_cluster_identifier, snapshot_type, db_snapshot_identifier

obtain information about one or more RDS snapshots. These can be for unclustered snapshots or snapshots of clustered DBs (Aurora) Aurora snapshot information may be obtained if no identifier parameters are passed or if one of the cluster parameters are passed. This module was called C(rds_snapshot_facts) before Ansible 2.9. The usage did not change.

Rds Subnet Group *arguments

manage RDS database subnet groups

Arguments: subnets, state, name, description

Creates, modifies, and deletes RDS database subnet groups. This module has a dependency on python-boto >= 2.5.

Read Csv *arguments

Read a CSV file

Arguments: dialect, skipinitialspace, fieldnames, strict, delimiter, key, path, unique

Read a CSV file and return a list or a dictionary, containing one dictionary per row.

Reboot *arguments

Reboot a machine

Arguments: pre_reboot_delay, post_reboot_delay, test_command, reboot_timeout, msg, search_paths, connect_timeout

Reboot a machine, wait for it to go down, come back up, and respond to commands. For Windows targets, use the M(win_reboot) module instead.

Redfish Command *arguments

Manages Out-Of-Band controllers using Redfish APIs

Arguments: category, username, uefi_target, baseuri, roleid, new_password, new_username, boot_next, command, timeout, password, bootdevice, id

Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action. Manages OOB controller ex. reboot, log management. Manages OOB controller users ex. add, remove, update. Manages system power ex. on, off, graceful and forced reboot.

Redfish Config *arguments

Manages Out-Of-Band controllers using Redfish APIs

Arguments: category, username, bios_attribute_value, baseuri, command, timeout, bios_attribute_name, password

Builds Redfish URIs locally and sends them to remote OOB controllers to set or update a configuration attribute. Manages BIOS configuration settings. Manages OOB controller configuration settings.

Redfish Info *arguments

Manages Out-Of-Band controllers using Redfish APIs

Arguments: category, username, command, timeout, baseuri, password

Builds Redfish URIs locally and sends them to remote OOB controllers to get information back. Information retrieved is placed in a location specified by the user. This module was called C(redfish_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(redfish_info) module no longer returns C(ansible_facts)!

Redhat Subscription *arguments

Manage registration and subscriptions to RHSM using the C(subscription-manager) command

Arguments: server_hostname, rhsm_repo_ca_cert, pool_ids, consumer_id, auto_attach, server_insecure, activationkey, server_proxy_password, consumer_name, rhsm_baseurl, pool, server_proxy_port, username, password, consumer_type, org_id, server_proxy_hostname, environment, force_register, state, server_proxy_user, release, syspurpose

Manage registration and subscription to the Red Hat Subscription Management entitlement platform using the C(subscription-manager) command

Redis *arguments

Various redis commands, slave and flush

Arguments: login_port, name, flush_mode, master_host, login_host, master_port, db, value, command, login_password, slave_mode

Unified utility to interact with redis instances.

Redshift *arguments

create, delete, or modify an Amazon Redshift instance

Arguments: cluster_parameter_group_name, username, new_cluster_identifier, number_of_nodes, availability_zone, encrypted, node_type, db_name, publicly_accessible, skip_final_cluster_snapshot, password, port, wait, allow_version_upgrade, cluster_type, elastic_ip, cluster_subnet_group_name, wait_timeout, command, cluster_security_groups, automated_snapshot_retention_period, identifier, cluster_version, final_cluster_snapshot_identifier, preferred_maintenance_window, vpc_security_group_ids

Creates, deletes, or modifies amazon Redshift cluster instances.

Redshift Cross Region Snapshots *arguments

Manage Redshift Cross Region Snapshots

Arguments: cluster_name, state, destination_region, snapshot_retention_period, region, snapshot_copy_grant

Manage Redshift Cross Region Snapshots. Supports KMS-Encrypted Snapshots. For more information, see https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-snapshots.html#cross-region-snapshot-copy

Redshift Info *arguments

Gather information about Redshift cluster(s)

Arguments: cluster_identifier, tags

Gather information about Redshift cluster(s) This module was called C(redshift_facts) before Ansible 2.9. The usage did not change.

Redshift Subnet Group *arguments

manage Redshift cluster subnet groups

Arguments: group_name, state, group_description, group_subnets

Create, modifies, and deletes Redshift cluster subnet groups.

Replace *arguments

Replace all instances of a particular string in a file using a back-referenced regular expression

Arguments: encoding, after, replace, path, regexp, backup, others, before

This module will replace all instances of a pattern within a file. It is up to the user to maintain idempotence by ensuring that the same pattern would never match any replacements made.

Restconf Config *arguments

Handles create, update, read and delete of configuration data on RESTCONF enabled devices.

Arguments: content, path, method, format

RESTCONF is a standard mechanisms to allow web applications to configure and manage data. RESTCONF is a IETF standard and documented on RFC 8040. This module allows the user to configure data on RESTCONF enabled devices.

Restconf Get *arguments

Fetch configuration/state data from RESTCONF enabled devices.

Arguments: content, path, output

RESTCONF is a standard mechanisms to allow web applications to access the configuration data and state data developed and standardized by the IETF. It is documented in RFC 8040. This module allows the user to fetch configuration and state data from RESTCONF enabled devices.

Rhevm *arguments

RHEV/oVirt automation

Arguments: vmhost, vmmem, cd_drive, image, cpu_share, insecure_api, cluster, user, password, port, vm_ha, disks, datacenter, name, ifaces, server, state, osver, mempol, timeout, del_prot, boot_order, type, vmcpu

This module only supports oVirt/RHEV version 3. A newer module M(ovirt_vm) supports oVirt/RHV version 4. Allows you to create/remove/update or powermanage virtual machines on a RHEV/oVirt platform.

Rhn Channel *arguments

Adds or removes Red Hat software channels

Arguments: sysname, state, name, url, password, user

Adds or removes Red Hat software channels.

Rhn Register *arguments

Manage Red Hat Network registration using the C(rhnreg_ks) command

Arguments: username, systemorgid, ca_cert, enable_eus, server_url, channels, state, activationkey, profilename, password, nopackages

Manage registration to the Red Hat Network.

Rhsm Release *arguments

Set or Unset RHSM Release version

Arguments: release

Sets or unsets the release version used by RHSM repositories.

Rhsm Repository *arguments

Manage RHSM repositories using the subscription-manager command

Arguments: purge, state, name

Manage (Enable/Disable) RHSM repositories to the Red Hat Subscription Management entitlement platform using the C(subscription-manager) command.

Riak *arguments

This module handles some common Riak operations

Arguments: target_node, config_dir, wait_for_service, http_conn, wait_for_ring, wait_for_handoffs, command, validate_certs

This module can be used to join nodes to a cluster, check the status of the cluster.

Rocketchat *arguments

Send notifications to Rocket Chat

Arguments: username, domain, protocol, attachments, color, icon_url, token, icon_emoji, link_names, msg, validate_certs, channel

The C(rocketchat) module sends notifications to Rocket Chat via the Incoming WebHook integration

Rollbar Deployment *arguments

Notify Rollbar about app deployments

Arguments: comment, rollbar_user, url, environment, token, user, validate_certs, revision

Notify Rollbar about app deployments (see https://rollbar.com/docs/deploys_other/)

Route 53 *arguments

add or delete entries in Amazons Route53 DNS service

Arguments: health_check, weight, hosted_zone_id, wait_timeout, ttl, overwrite, wait, alias_hosted_zone_id, zone, record, region, retry_interval, state, value, alias, private_zone, alias_evaluate_target_health, vpc_id, identifier, type, failover

Creates and deletes DNS records in Amazons Route53 service

Route53 Health Check *arguments

add or delete health-checks in Amazons Route53 DNS service

Arguments: request_interval, type, fqdn, port, state, resource_path, failure_threshold, ip_address, string_match

Creates and deletes DNS Health checks in Amazons Route53 service Only the port, resource_path, string_match and request_interval are considered when updating existing health-checks.

Route53 Info *arguments

Retrieves route53 details using AWS methods

Arguments: start_record_name, resource_id, hosted_zone_method, dns_name, health_check_method, delegation_set_id, max_items, hosted_zone_id, health_check_id, change_id, query, next_marker, type

Gets various details related to Route53 zone, record set or health check details. This module was called C(route53_facts) before Ansible 2.9. The usage did not change.

Route53 Zone *arguments

add or delete Route53 zones

Arguments: comment, hosted_zone_id, state, vpc_region, zone, vpc_id, delegation_set_id

Creates and deletes Route53 private and public zones

Routeros Command *arguments

Run commands on remote devices running MikroTik RouterOS

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an RouterOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.

Routeros Facts *arguments

Collect facts from remote devices running MikroTik RouterOS

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running RotuerOS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Rpm Key *arguments

Adds or removes a gpg key from the rpm db

Arguments: state, validate_certs, key, fingerprint

Adds or removes (rpm --import) a gpg key to your rpm database.

Rundeck Acl Policy *arguments

Manage Rundeck ACL policies.

Arguments: project, policy, state, name, url, token, api_version

Create, update and remove Rundeck ACL policies through HTTP API.

Rundeck Project *arguments

Manage Rundeck projects.

Arguments: url, token, state, api_version, name

Create and remove Rundeck projects through HTTP API.

Runit *arguments

Manage runit services

Arguments: state, enabled, name, service_dir, service_src

Controls runit services on remote hosts using the sv utility.

S3 Bucket *arguments

Manage S3 buckets in AWS, DigitalOcean, Ceph, Walrus and FakeS3

Arguments: force, name, tags, purge_tags, ceph, state, encryption_key_id, encryption, policy, s3_url, requester_pays, versioning

Manage S3 buckets in AWS, DigitalOcean, Ceph, Walrus and FakeS3

S3 Bucket Notification *arguments

Creates, updates or deletes S3 Bucket notification for lambda

Arguments: lambda_alias, suffix, event_name, lambda_function_arn, state, lambda_version, prefix, bucket_name, events

This module allows the management of AWS Lambda function bucket event mappings via the Ansible framework. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases and M(lambda_policy) to modify lambda permissions.

S3 Lifecycle *arguments

Manage s3 bucket lifecycle rules in AWS

Arguments: status, purge_transitions, state, noncurrent_version_transition_days, prefix, expiration_days, noncurrent_version_expiration_days, transitions, transition_days, name, expiration_date, noncurrent_version_storage_class, noncurrent_version_transitions, storage_class, rule_id, transition_date

Manage s3 bucket lifecycle rules in AWS

S3 Logging *arguments

Manage logging facility of an s3 bucket in AWS

Arguments: target_bucket, state, name, target_prefix

Manage logging facility of an s3 bucket in AWS

S3 Sync *arguments

Efficiently upload multiple files to S3

Arguments: file_change_strategy, file_root, permission, bucket, mime_map, mode, exclude, include, cache_control, key_prefix, delete

The S3 module is great, but it is very slow for a large volume of files- even a dozen will be noticeable. In addition to speed, it handles globbing, inclusions/exclusions, mime types, expiration mapping, recursion, cache control and smart directory mapping.

S3 Website *arguments

Configure an s3 bucket as a website

Arguments: redirect_all_requests, state, suffix, name, region, error_key

Configure an s3 bucket as a website

Say *arguments

Makes a computer to speak.

Arguments: msg, voice

makes a computer speak! Amuse your friends, annoy your coworkers!

Scaleway Compute *arguments

Scaleway compute management module

Arguments: name, tags, enable_ipv6, wait_sleep_time, public_ip, state, wait_timeout, security_group, organization, commercial_type, region, image, wait

This module manages compute instances on Scaleway.

Scaleway Image Info *arguments

Gather information about the Scaleway images available.

Arguments: region

Gather information about the Scaleway images available.

Scaleway Ip *arguments

Scaleway IP management module

Arguments: state, reverse, organization, region, id, server

This module manages IP on Scaleway account U(https://developer.scaleway.com)

Scaleway Ip Info *arguments

Gather information about the Scaleway ips available.

Arguments: region

Gather information about the Scaleway ips available.

Scaleway Lb *arguments

Scaleway load-balancer management module

Arguments: name, tags, region, description, organization_id, state, wait_timeout, wait_sleep_time, wait

This module manages load-balancers on Scaleway.

Scaleway Organization Info *arguments

Gather information about the Scaleway organizations available.

Arguments: api_url

Gather information about the Scaleway organizations available.

Scaleway Security Group *arguments

Scaleway Security Group management module

Arguments: outbound_default_policy, description, region, stateful, state, inbound_default_policy, organization, organization_default, name

This module manages Security Group on Scaleway account U(https://developer.scaleway.com).

Scaleway Security Group Info *arguments

Gather information about the Scaleway security groups available.

Arguments: region

Gather information about the Scaleway security groups available.

Scaleway Security Group Rule *arguments

Scaleway Security Group Rule management module

Arguments: direction, protocol, region, action, state, ip_range, security_group, port

This module manages Security Group Rule on Scaleway account U(https://developer.scaleway.com)

Scaleway Server Info *arguments

Gather information about the Scaleway servers available.

Arguments: region

Gather information about the Scaleway servers available.

Scaleway Snapshot Info *arguments

Gather information about the Scaleway snapshots available.

Arguments: region

Gather information about the Scaleway snapshot available.

Scaleway Sshkey *arguments

Scaleway SSH keys management module

Arguments: state, ssh_pub_key, api_url

This module manages SSH keys on Scaleway account U(https://developer.scaleway.com)

Scaleway User Data *arguments

Scaleway user_data management module

Arguments: region, server_id, user_data

This module manages user_data on compute instances on Scaleway. It can be used to configure cloud-init for instance

Scaleway Volume *arguments

Scaleway volumes management module

Arguments: state, name, organization, region, volume_type, size

This module manages volumes on Scaleway account U(https://developer.scaleway.com)

Scaleway Volume Info *arguments

Gather information about the Scaleway volumes available.

Arguments: region

Gather information about the Scaleway volumes available.

Script *arguments

Runs a local script on a remote node after transferring it

Arguments: creates, executable, chdir, cmd, removes, free_form

The C(script) module takes the script name followed by a list of space-delimited arguments. Either a free form command or C(cmd) parameter is required, see the examples. The local script at path will be transferred to the remote node and then executed. The given script will be processed through the shell environment on the remote node. This module does not require python on the remote system, much like the M(raw) module. This module is also supported for Windows targets.

Seboolean *arguments

Toggles SELinux booleans

Arguments: state, persistent, name, ignore_selinux_state

Toggles SELinux booleans.

Sefcontext *arguments

Manages SELinux file context mapping definitions

Arguments: target, selevel, seuser, state, ignore_selinux_state, reload, setype, ftype

Manages SELinux file context mapping definitions. Similar to the C(semanage fcontext) command.

Selinux *arguments

Change policy and state of SELinux

Arguments: policy, state, configfile

Configures the SELinux mode and policy. A reboot may be required after usage. Ansible will not issue this reboot but will let you know when it is required.

Selinux Permissive *arguments

Change permissive domain in SELinux policy

Arguments: domain, no_reload, store, permissive

Add and remove a domain from the list of permissive domains.

Selogin *arguments

Manages linux user to SELinux user mapping

Arguments: reload, state, selevel, login, seuser, ignore_selinux_state

Manages linux user to SELinux user mapping

Sendgrid *arguments

Sends an email with the SendGrid API

Arguments: username, from_name, from_address, cc, subject, bcc, headers, to_addresses, html_body, api_key, password, attachments

Sends an email with a SendGrid account through their API, not through the SMTP service.

Sensu Check *arguments

Manage Sensu checks

Arguments: interval, handle, subscribers, metric, subdue_begin, dependencies, occurrences, low_flap_threshold, ttl, aggregate, path, name, standalone, backup, handlers, publish, custom, source, state, command, high_flap_threshold, timeout, subdue_end, refresh

Manage the checks that should be run on a machine by I(Sensu). Most options do not have a default and will not be added to the check definition unless specified. All defaults except I(path), I(state), I(backup) and I(metric) are not managed by this module, they are simply specified for your convenience.

Sensu Client *arguments

Manages Sensu client configuration

Arguments: subscriptions, address, chef, redact, socket, puppet, ec2, safe_mode, registration, deregistration, keepalive, deregister, name, state, keepalives, servicenow

Manages Sensu client configuration. For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/clients.html)

Sensu Handler *arguments

Manages Sensu handler configuration

Arguments: filter, name, handlers, filters, severities, pipe, mutator, state, command, timeout, handle_flapping, handle_silenced, type, socket

Manages Sensu handler configuration For more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/handlers.html)

Sensu Silence *arguments

Manage Sensu silence entries

Arguments: expire_on_resolve, url, creator, state, reason, expire, check, subscription

Create and clear (delete) a silence entries via the Sensu API for subscriptions and checks.

Sensu Subscription *arguments

Manage Sensu subscriptions

Arguments: path, state, backup, name

Manage which I(sensu channels) a machine should subscribe to

Seport *arguments

Manages SELinux network port type definitions

Arguments: ports, reload, state, proto, setype, ignore_selinux_state

Manages SELinux network port type definitions.

Serverless *arguments

Manages a Serverless Framework project

Arguments: functions, force, verbose, deploy, region, state, serverless_bin_path, service_path, stage

Provides support for managing Serverless Framework (https://serverless.com/) project deployments and stacks.

Service *arguments

Manage services

Arguments: use, name, pattern, enabled, state, sleep, arguments, runlevel

Controls services on remote hosts. Supported init systems include BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart. For Windows targets, use the M(win_service) module instead.

Service Facts *arguments

Return service state information as fact data

Arguments:

Return service state information as fact data for various service management utilities

Set Fact *arguments

Set host facts from a task

Arguments: key_value, cacheable

This module allows setting new variables. Variables are set on a host-by-host basis just like facts discovered by the setup module. These variables will be available to subsequent plays during an ansible-playbook run. Set C(cacheable) to C(yes) to save variables across executions using a fact cache. Variables created with set_fact have different precedence depending on whether they are or are not cached. Per the standard Ansible variable precedence rules, many other types of variables have a higher priority, so this value may be overridden. This module is also supported for Windows targets.

Set Internals n, v
Set Stats *arguments

Set stats for the current ansible run

Arguments: aggregate, data, per_host

This module allows setting/accumulating stats on the current ansible run, either per host or for all hosts in the run. This module is also supported for Windows targets.

Setup *arguments

Gathers facts about remote hosts

Arguments: filter, gather_subset, fact_path, gather_timeout

This module is automatically called by playbooks to gather useful variables about remote hosts that can be used in playbooks. It can also be executed directly by C(/usr/bin/ansible) to check what variables are available to a host. Ansible provides many I(facts) about the system, automatically. This module is also supported for Windows targets.

Shell *arguments

Execute shell commands on targets

Arguments: creates, executable, chdir, cmd, removes, warn, free_form, stdin_add_newline, stdin

The C(shell) module takes the command name followed by a list of space-delimited arguments. Either a free form command or C(cmd) parameter is required, see the examples. It is almost exactly like the M(command) module but runs the command through a shell (C(/bin/sh)) on the remote node. For Windows targets, use the M(win_shell) module instead.

Skydive Capture *arguments

Module which manages flow capture on interfaces

Arguments: capture_name, description, layer_key_mode, state, extra_tcp_metric, ip_defrag, query, reassemble_tcp, interface_name, type

This module manages flow capture on interfaces. The Gremlin expression is continuously evaluated which means that it is possible to define a capture on nodes that do not exist yet. It is useful when you want to start a capture on all OpenvSwitch whatever the number of Skydive agents you will start. While starting the capture, user can specify the capture name, capture description and capture type optionally.

Skydive Edge *arguments

Module to add edges to Skydive topology

Arguments: state, child_node, parent_node, host, relation_type, metadata

This module handles setting up edges between two nodes based on the relationship type to the Skydive topology.

Skydive Node *arguments

Module which add nodes to Skydive topology

Arguments: state, seed, name, host, node_type, metadata

This module handles adding node to the Skydive topology.

Sl Vm *arguments

create or cancel a virtual instance in SoftLayer

Arguments: domain, disks, tags, instance_id, dedicated, private, cpus, image_id, nic_speed, private_vlan, datacenter, public_vlan, wait, hourly, ssh_keys, hostname, os_code, wait_time, local_disk, state, post_uri, memory

Creates or cancels SoftLayer instances. When created, optionally waits for it to be 'running'.

Slack *arguments

Send Slack notifications

Arguments: username, domain, attachments, color, icon_url, parse, thread_id, token, icon_emoji, link_names, msg, validate_certs, channel

The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration

Slackpkg *arguments

Package manager for Slackware >= 12.2

Arguments: state, update_cache, name

Manage binary packages for Slackware using 'slackpkg' which is available in versions after 12.2.

Slurp *arguments

Slurps a file from remote nodes

Arguments: src

This module works like M(fetch). It is used for fetching a base64- encoded blob containing the data in a remote file. This module is also supported for Windows targets.

Slxos Command *arguments

Run commands on remote devices running Extreme Networks SLX-OS

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an SLX node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(slxos_config) to configure SLX-OS devices.

Slxos Config *arguments

Manage Extreme Networks SLX-OS configuration sections

Arguments: multiline_delimiter, backup_options, after, diff_against, replace, running_config, diff_ignore_lines, src, lines, intended_config, parents, defaults, before, save_when, backup, match

Extreme SLX-OS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with SLX-OS configuration sections in a deterministic way.

Slxos Facts *arguments

Collect facts from devices running Extreme SLX-OS

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running SLX-OS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Slxos Interface *arguments

Manage Interfaces on Extreme SLX-OS network devices

Arguments: neighbors, rx_rate, name, enabled, mtu, delay, state, aggregate, speed, tx_rate, description

This module provides declarative management of Interfaces on Extreme SLX-OS network devices.

Slxos L2 Interface *arguments

Manage Layer-2 interface on Extreme Networks SLX-OS devices.

Arguments: native_vlan, access_vlan, name, trunk_vlans, state, trunk_allowed_vlans, mode, aggregate

This module provides declarative management of Layer-2 interface on Extreme slxos devices.

Slxos L3 Interface *arguments

Manage L3 interfaces on Extreme Networks SLX-OS network devices.

Arguments: aggregate, state, ipv4, name, ipv6

This module provides declarative management of L3 interfaces on slxos network devices.

Slxos Linkagg *arguments

Manage link aggregation groups on Extreme Networks SLX-OS network devices

Arguments: purge, state, group, mode, members, aggregate

This module provides declarative management of link aggregation groups on Extreme Networks SLX-OS network devices.

Slxos Lldp *arguments

Manage LLDP configuration on Extreme Networks SLX-OS network devices.

Arguments: state

This module provides declarative management of LLDP service on Extreme SLX-OS network devices.

Slxos Vlan *arguments

Manage VLANs on Extreme Networks SLX-OS network devices

Arguments: purge, delay, state, name, aggregate, interfaces, vlan_id

This module provides declarative management of VLANs on Extreme SLX-OS network devices.

Smartos Image Info *arguments

Get SmartOS image details.

Arguments: filters

Retrieve information about all installed images on SmartOS. This module was called C(smartos_image_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(smartos_image_info) module no longer returns C(ansible_facts)!

Snap *arguments

Manages snaps

Arguments: state, name, channel, classic

Manages snaps packages.

Snmp Facts *arguments

Retrieve facts for a device using SNMP

Arguments: username, level, privacy, community, authkey, host, version, integrity, privkey

Retrieve facts for a device using SNMP, the facts will be inserted to the ansible_facts key.

Snow Record *arguments

Manage records in ServiceNow

Arguments: state, attachment, table, lookup_field, data, number

Creates, deletes and updates a single record in ServiceNow.

Snow Record Find *arguments

Search for multiple records from ServiceNow

Arguments: table, max_records, return_fields, order_by, query

Gets multiple records from a specified table from ServiceNow based on a query dictionary.

Sns *arguments

Send Amazon Simple Notification Service messages

Arguments: http, sqs, sms, subject, topic, application, https, msg, message_attributes, email_json, email, message_structure, lambda

Sends a notification to a topic on your Amazon SNS account.

Sns Topic *arguments

Manages AWS SNS topics and subscriptions

Arguments: state, display_name, name, subscriptions, policy, purge_subscriptions, delivery_policy

The C(sns_topic) module allows you to create, delete, and manage subscriptions for AWS SNS topics. As of 2.6, this module can be use to subscribe and unsubscribe to topics outside of your AWS account.

Solaris Zone *arguments

Manage Solaris zones

Arguments: install_options, name, sparse, create_options, state, root_password, timeout, path, config, attach_options

Create, start, stop and delete Solaris zones. This module does not currently allow changing of options for a zone that is already been created.

Sorcery *arguments

Package manager for Source Mage GNU/Linux

Arguments: depends, update_cache, name, state, update, cache_valid_time

Manages "spells" on Source Mage GNU/Linux using I(sorcery) toolchain

Spectrum Device *arguments

Creates/deletes devices in CA Spectrum.

Arguments: url_password, use_proxy, url, community, agentport, state, url_username, device, validate_certs, landscape

This module allows you to create and delete devices in CA Spectrum U(https://www.ca.com/us/products/ca-spectrum.html). Tested on CA Spectrum 9.4.2, 10.1.1 and 10.2.1

Spotinst Aws Elastigroup *arguments

Create, update or delete Spotinst AWS Elastigroups

Arguments: ebs_volume_pool, opsworks, ebs_optimized, roll_config, shutdown_script, elastic_ips, account_id, chef, iam_role_name, spin_up_time, id, unit, risk, availability_zones, monitoring, kubernetes, right_scale, health_check_grace_period, draining_timeout, target_group_arns, iam_role_arn, name, signals, state, health_check_type, key_pair, down_scaling_policies, health_check_unhealthy_duration_before_replacement, rancher, on_demand_count, fallback_to_od, on_demand_instance_type, ignore_changes, product, scheduled_tasks, target_tracking_policies, tags, mesosphere, min_size, image_id, wait_timeout, ecs, terminate_at_end_of_billing_hour, load_balancers, security_group_ids, max_size, block_device_mappings, uniqueness_by, credentials_path, up_scaling_policies, availability_vs_cost, network_interfaces, lifetime_period, tenancy, user_data, persistence, utilize_reserved_instances, target, wait_for_instances, spot_instance_types

Can create, update, or delete Spotinst AWS Elastigroups Launch configuration is part of the elastigroup configuration, so no additional modules are necessary for handling the launch configuration. You will have to have a credentials file in this location - <home>/.spotinst/credentials The credentials file must contain a row that looks like this token = <YOUR TOKEN> Full documentation available at https://help.spotinst.com/hc/en-us/articles/115003530285-Ansible-

Sqs Queue *arguments

Creates or deletes AWS SQS queues.

Arguments: message_retention_period, name, delivery_delay, default_visibility_timeout, state, maximum_message_size, policy, redrive_policy, receive_message_wait_time

Create or delete AWS SQS queues. Update attributes on existing queues.

Sros Command *arguments

Run commands on remote devices running Nokia SR OS

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an SR OS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(sros_config) to configure SR OS devices.

Sros Config *arguments

Manage Nokia SR OS device configuration

Arguments: src, backup_options, force, backup, after, lines, replace, parents, defaults, save, config, match, before

Nokia SR OS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with SR OS configuration sections in a deterministic way.

Sros Rollback *arguments

Configure Nokia SR OS rollback

Arguments: state, local_max_checkpoints, rescue_location, rollback_location, remote_max_checkpoints

Configure the rollback feature on remote Nokia devices running the SR OS operating system. this module provides a stateful implementation for managing the configuration of the rollback feature

Ss 3par Cpg *arguments

Manage HPE StoreServ 3PAR CPG

Arguments: domain, secure, cpg_name, raid_type, growth_increment, state, set_size, growth_warning, disk_type, growth_limit, high_availability

Create and delete CPG on HPE 3PAR.

Stackdriver *arguments

Send code deploy and annotation events to stackdriver

Arguments: repository, level, annotated_by, deployed_to, deployed_by, instance_id, key, msg, event_epoch, revision_id, event

Send code deploy and annotation events to Stackdriver

Stacki Host *arguments

Add or remove host to stacki front-end

Arguments: prim_intf_ip, name, stacki_user, stacki_endpoint, prim_intf, stacki_password, force_install, prim_intf_mac

Use this module to add or remove hosts to a stacki front-end via API. U(https://github.com/StackIQ/stacki)

Stat *arguments

Retrieve file or file system status

Arguments: get_checksum, follow, checksum_algorithm, path, get_mime, get_attributes

Retrieves facts for a file similar to the Linux/Unix 'stat' command. For Windows targets, use the M(win_stat) module instead.

Statusio Maintenance *arguments

Create maintenance windows for your status.io dashboard

Arguments: maintenance_notify_72_hr, maintenance_notify_now, start_time, api_id, automation, maintenance_notify_24_hr, all_infrastructure_affected, maintenance_id, desc, maintenance_notify_1_hr, title, url, state, components, statuspage, api_key, minutes, start_date, containers

Creates a maintenance window for status.io Deletes a maintenance window for status.io

Sts Assume Role *arguments

Assume a role using AWS Security Token Service and obtain temporary credentials

Arguments: role_session_name, mfa_token, role_arn, duration_seconds, policy, mfa_serial_number, external_id

Assume a role using AWS Security Token Service and obtain temporary credentials

Sts Session Token *arguments

Obtain a session token from the AWS Security Token Service

Arguments: mfa_token, mfa_serial_number, duration_seconds

Obtain a session token from the AWS Security Token Service

Subversion *arguments

Deploys a subversion repository

Arguments: username, executable, force, dest, update, repo, switch, export, in_place, password, checkout, revision

Deploy given repository URL / revision to dest. If dest exists, update to the specified revision, otherwise perform a checkout.

Supervisorctl *arguments

Manage the state of a program or group of programs running via supervisord

Arguments: username, supervisorctl_path, name, signal, server_url, state, password, config

Manage the state of a program or group of programs running via supervisord

Svc *arguments

Manage daemontools services

Arguments: service_dir, name, downed, enabled, state, service_src

Controls daemontools services on remote hosts using the svc utility.

Svr 4 Pkg *arguments

Manage Solaris SVR4 packages

Arguments: category, src, state, name, zone, response_file, proxy

Manages SVR4 packages on Solaris 10 and 11. These were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11. Note that this is a very basic packaging system. It will not enforce dependencies on install or remove.

Swdepot *arguments

Manage packages with swdepot package manager (HP-UX)

Arguments: state, depot, name

Will install, upgrade and remove packages with swdepot package manager (HP-UX)

Swupd *arguments

Manages updates and bundles in ClearLinux systems.

Arguments: contenturl, name, format, url, verify, update, manifest, state, versionurl

Manages updates and bundles with the swupd bundle manager, which is used by the Clear Linux Project for Intel Architecture.

Synchronize *arguments

A wrapper around rsync to make common tasks in your playbooks quick and easy

Arguments: dirs, private_key, partial, links, copy_links, perms, compress, rsync_timeout, rsync_opts, owner, existing_only, set_remote_user, times, rsync_path, dest_port, src, group, link_dest, recursive, archive, dest, mode, checksum, verify_host, use_ssh_args, delete

C(synchronize) is a wrapper around rsync to make common tasks in your playbooks quick and easy. It is run and originates on the local host where Ansible is being run. Of course, you could just use the C(command) action to call rsync yourself, but you also have to add a fair number of boilerplate options and host facts. This module is not intended to provide access to the full power of rsync, but does make the most common invocations easier to implement. You still may need to call rsync directly via C(command) or C(shell) depending on your use case.

Sysctl *arguments

Manage entries in sysctl.conf.

Arguments: reload, state, name, sysctl_set, ignoreerrors, sysctl_file, value

This module manipulates sysctl entries and optionally performs a C(/sbin/sysctl -p) after changing them.

Syslogger *arguments

Log messages in the syslog

Arguments: msg, priority, facility, log_pid

Uses syslog to add log entries to the host. Can specify facility and priority.

Syspatch *arguments

Manage OpenBSD system patches

Arguments: apply, revert

Manage OpenBSD system patches using syspatch

Systemd *arguments

Manage services

Arguments: no_block, force, name, daemon_reexec, enabled, daemon_reload, state, masked, scope, user

Controls systemd services on remote hosts.

Sysvinit *arguments

Manage SysV services.

Arguments: name, runlevels, pattern, enabled, state, daemonize, sleep, arguments

Controls services on target hosts that use the SysV init system.

Taiga Issue *arguments

Creates/deletes an issue in a Taiga Project Management Platform

Arguments: status, project, severity, tags, priority, taiga_host, state, attachment, issue_type, subject, attachment_description, description

Creates/deletes an issue in a Taiga Project Management Platform (U(https://taiga.io)). An issue is identified by the combination of project, issue subject and issue type. This module implements the creation or deletion of issues (not the update).

Telegram *arguments

module for sending notifications via telegram

Arguments: msg, msg_format, token, chat_id

Send notifications via telegram bot, to a verified group or user

Telnet *arguments

Executes a low-down and dirty telnet command

Arguments: pause, password_prompt, host, prompts, command, user, timeout, login_prompt, password, port, send_newline

Executes a low-down and dirty telnet command, not going through the module subsystem. This is mostly to be used for enabling ssh on devices that only have telnet enabled by default.

Tempfile *arguments

Creates temporary files and directories

Arguments: path, state, prefix, suffix

The C(tempfile) module creates temporary files and directories. C(mktemp) command takes different parameters on various systems, this module helps to avoid troubles related to that. Files/directories created by module are accessible only by creator. In case you need to make them world-accessible you need to use M(file) module. For Windows targets, use the M(win_tempfile) module instead.

Template *arguments

Template a file out to a remote server

Arguments: follow

Template a file out to a remote server

Terraform *arguments

Manages a Terraform deployment (and plans)

Arguments: variables_file, backend_config, lock_timeout, lock, variables, project_path, state, plan_file, purge_workspace, state_file, workspace, force_init, binary_path, targets

Provides support for deploying resources with Terraform and pulling resource information back into Ansible.

Timezone *arguments

Configure timezone setting

Arguments: hwclock, name

This module configures the timezone setting, both of the system clock and of the hardware clock. If you want to set up the NTP, use M(service) module. It is recommended to restart C(crond) after changing the timezone, otherwise the jobs may run at the wrong time. Several different tools are used depending on the OS/Distribution involved. For Linux it can use C(timedatectl) or edit C(/etc/sysconfig/clock) or C(/etc/timezone) and C(hwclock). On SmartOS, C(sm-set-timezone), for macOS, C(systemsetup), for BSD, C(/etc/localtime) is modified. On AIX, C(chtz) is used. As of Ansible 2.3 support was added for SmartOS and BSDs. As of Ansible 2.4 support was added for macOS. As of Ansible 2.9 support was added for AIX 6.1+ Windows and HPUX are not supported, please let us know if you find any other OS/distro in which this fails.

Tower Credential *arguments

create, update, or destroy Ansible Tower credential.

Arguments: authorize, username, domain, description, vault_password, team, host, vault_id, user, become_password, become_username, password, tenant, subscription, kind, become_method, name, security_token, secret, project, state, client, ssh_key_data, ssh_key_unlock, organization, authorize_password

Create, update, or destroy Ansible Tower credentials. See U(https://www.ansible.com/tower) for an overview.

Tower Credential Type *arguments

Create, update, or destroy custom Ansible Tower credential type.

Arguments: inputs, kind, name, injectors, validate_certs, state, description

Create, update, or destroy Ansible Tower credential type. See U(https://www.ansible.com/tower) for an overview.

Tower Group *arguments

create, update, or destroy Ansible Tower group.

Arguments: credential, source_vars, source_script, update_on_launch, overwrite_vars, source_regions, variables, description, instance_filters, source, state, group_by, inventory, overwrite, name

Create, update, or destroy Ansible Tower groups. See U(https://www.ansible.com/tower) for an overview.

Tower Host *arguments

create, update, or destroy Ansible Tower host.

Arguments: state, name, variables, description, enabled, inventory

Create, update, or destroy Ansible Tower hosts. See U(https://www.ansible.com/tower) for an overview.

Tower Inventory *arguments

create, update, or destroy Ansible Tower inventory.

Arguments: host_filter, kind, name, organization, variables, state, description

Create, update, or destroy Ansible Tower inventories. See U(https://www.ansible.com/tower) for an overview.

Tower Inventory Source *arguments

create, update, or destroy Ansible Tower inventory source.

Arguments: credential, description, overwrite_vars, source_regions, overwrite, name, source_vars, source_script, update_on_launch, source, update_cache_timeout, source_project, source_path, instance_filters, update_on_project_update, state, group_by, inventory, timeout, validate_certs

Create, update, or destroy Ansible Tower inventories source. See U(https://www.ansible.com/tower) for an overview.

Tower Job Cancel *arguments

Cancel an Ansible Tower Job.

Arguments: job_id, fail_if_not_running

Cancel Ansible Tower jobs. See U(https://www.ansible.com/tower) for an overview.

Tower Job Launch *arguments

Launch an Ansible Job.

Arguments: credential, use_job_endpoint, job_template, tags, extra_vars, job_explanation, job_type, limit, inventory

Launch an Ansible Tower jobs. See U(https://www.ansible.com/tower) for an overview.

Tower Job List *arguments

List Ansible Tower jobs.

Arguments: status, query, page, all_pages

List Ansible Tower jobs. See U(https://www.ansible.com/tower) for an overview.

Tower Job Template *arguments

create, update, or destroy Ansible Tower job template.

Arguments: ask_diff_mode, ask_limit, job_type, ask_job_type, skip_tags, playbook, survey_enabled, job_tags, force_handlers_enabled, state, inventory, limit, forks, concurrent_jobs_enabled, vault_credential, diff_mode_enabled, become_enabled, credential, ask_verbosity, description, fact_caching_enabled, ask_skip_tags, start_at_task, ask_inventory, host_config_key, survey_spec, ask_credential, name, verbosity, project, ask_extra_vars, extra_vars_path, ask_tags

Create, update, or destroy Ansible Tower job templates. See U(https://www.ansible.com/tower) for an overview.

Tower Job Wait *arguments

Wait for Ansible Tower job to finish.

Arguments: min_interval, max_interval, job_id, timeout

Wait for Ansible Tower job to finish and report success or failure. See U(https://www.ansible.com/tower) for an overview.

Tower Label *arguments

create, update, or destroy Ansible Tower label.

Arguments: organization, state, name

Create, update, or destroy Ansible Tower labels. See U(https://www.ansible.com/tower) for an overview.

Tower Notification *arguments

create, update, or destroy Ansible Tower notification.

Arguments: message_from, color, channels, from_number, rooms, use_ssl, notification_type, service_key, account_sid, notification_configuration, port, api_url, client_name, targets, use_tls, state, subdomain, username, description, recipients, host, to_numbers, password, nickname, sender, name, url, account_token, server, headers, token, organization, notify

Create, update, or destroy Ansible Tower notifications. See U(https://www.ansible.com/tower) for an overview.

Tower Organization *arguments

create, update, or destroy Ansible Tower organizations

Arguments: state, name, description

Create, update, or destroy Ansible Tower organizations. See U(https://www.ansible.com/tower) for an overview.

Tower Project *arguments

create, update, or destroy Ansible Tower projects

Arguments: scm_branch, name, scm_update_cache_timeout, scm_credential, scm_clean, scm_url, scm_delete_on_update, state, local_path, scm_type, custom_virtualenv, organization, scm_update_on_launch, job_timeout, description

Create, update, or destroy Ansible Tower projects. See U(https://www.ansible.com/tower) for an overview.

Tower Receive *arguments

Receive assets from Ansible Tower.

Arguments: credential, all, job_template, workflow, inventory_script, project, credential_type, user, team, organization, notification_template, inventory

Receive assets from Ansible Tower. See U(https://www.ansible.com/tower) for an overview.

Tower Role *arguments

create, update, or destroy Ansible Tower role.

Arguments: credential, job_template, project, state, role, inventory, team, organization, target_team, user

Create, update, or destroy Ansible Tower roles. See U(https://www.ansible.com/tower) for an overview.

Tower Send *arguments

Send assets to Ansible Tower.

Arguments: files, prevent, assets, password_management

Send assets to Ansible Tower. See U(https://www.ansible.com/tower) for an overview.

Tower Settings *arguments

Modify Ansible Tower settings.

Arguments: name, value

Modify Ansible Tower settings. See U(https://www.ansible.com/tower) for an overview.

Tower Team *arguments

create, update, or destroy Ansible Tower team.

Arguments: organization, state, name

Create, update, or destroy Ansible Tower teams. See U(https://www.ansible.com/tower) for an overview.

Tower User *arguments

create, update, or destroy Ansible Tower user.

Arguments: username, superuser, first_name, last_name, state, auditor, password, email

Create, update, or destroy Ansible Tower users. See U(https://www.ansible.com/tower) for an overview.

Tower Workflow Launch *arguments

Run a workflow in Ansible Tower

Arguments: workflow_template, extra_vars, timeout, wait

Launch an Ansible Tower workflows. See U(https://www.ansible.com/tower) for an overview.

Tower Workflow Template *arguments

create, update, or destroy Ansible Tower workflow template.

Arguments: description, allow_simultaneous, extra_vars, name, state, ask_extra_vars, survey, inventory, ask_inventory, organization, survey_enabled, schema

Create, update, or destroy Ansible Tower workflows. See U(https://www.ansible.com/tower) for an overview.

Twilio *arguments

Sends a text message to a mobile phone through Twilio.

Arguments: from_number, to_numbers, msg, auth_token, media_url, account_sid

Sends a text message to a phone number through the Twilio messaging API.

Typetalk *arguments

Send a message to typetalk

Arguments: topic, client_secret, client_id, msg

Send a message to typetalk using typetalk API

Ucs Disk Group Policy *arguments

Configures disk group policies on Cisco UCS Manager

Arguments: configuration_mode, name, description, use_remaining_disks, raid_level, org_dn, virtual_drive, state, num_ded_hot_spares, drive_type, num_drives, min_drive_size, num_glob_hot_spares, manual_disks

Configures disk group policies on Cisco UCS Manager. Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).

Ucs Dns Server *arguments

Configure DNS servers on Cisco UCS Manager

Arguments: delegate_to, state, dns_server, description

Configure DNS servers on Cisco UCS Manager. Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).

Ucs Ip Pool *arguments

Configures IP address pools on Cisco UCS Manager

Arguments: ipv6_primary_dns, description, default_gw, org_dn, subnet_mask, ipv6_first_addr, ipv6_secondary_dns, secondary_dns, name, last_addr, primary_dns, state, first_addr, order, ipv6_last_addr, ipv6_prefix, ipv6_default_gw

Configures IP address pools and blocks of IP addresses on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Lan Connectivity *arguments

Configures LAN Connectivity Policies on Cisco UCS Manager

Arguments: state, name, iscsi_vnic_list, org_dn, vnic_list, description

Configures LAN Connectivity Policies on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Mac Pool *arguments

Configures MAC address pools on Cisco UCS Manager

Arguments: state, name, last_addr, description, org_dn, first_addr, order

Configures MAC address pools and MAC address blocks on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Managed Objects *arguments

Configures Managed Objects on Cisco UCS Manager

Arguments: state, objects

Configures Managed Objects on Cisco UCS Manager. The Python SDK module, Python class within the module (UCSM Class), and all properties must be directly specified. More information on the UCSM Python SDK and how to directly configure Managed Objects is available at L(UCSM Python SDK,http://ucsmsdk.readthedocs.io/). Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Ntp Server *arguments

Configures NTP server on Cisco UCS Manager

Arguments: state, ntp_server, description

Configures NTP server on Cisco UCS Manager. Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).

Ucs Org *arguments

Manages UCS Organizations for UCS Manager

Arguments: org_name, delegate_to, state, parent_org_path, description

Manages UCS Organizations for UCS Manager. Examples can be used with the UCS Platform Emulator U(https://cs.co/ucspe).

Ucs San Connectivity *arguments

Configures SAN Connectivity Policies on Cisco UCS Manager

Arguments: vhba_list, state, name, wwnn_pool, org_dn, description

Configures SAN Connectivity Policies on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Service Profile Template *arguments

Configures Service Profile Templates on Cisco UCS Manager

Arguments: mgmt_interface_mode, server_pool_qualification, description, storage_profile, san_connectivity_policy, mgmt_vnet_name, org_dn, lan_connectivity_policy, template_type, iqn_pool, state, maintenance_policy, bios_policy, power_state, user_label, server_pool, mgmt_inband_pool_name, ipmi_access_profile, local_disk_policy, power_control_policy, power_sync_policy, kvm_mgmt_policy, sol_policy, name, scrub_policy, threshold_policy, mgmt_ip_pool, boot_policy, host_firmware_package, uuid_pool, graphics_card_policy, vmedia_policy

Configures Service Profile Templates on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Storage Profile *arguments

Configures storage profiles on Cisco UCS Manager

Arguments: local_luns, description, state, name, org_dn

Configures storage profiles on Cisco UCS Manager. Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).

Ucs Timezone *arguments

Configures timezone on Cisco UCS Manager

Arguments: timezone, state, admin_state, description

Configures timezone on Cisco UCS Manager. Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).

Ucs Uuid Pool *arguments

Configures server UUID pools on Cisco UCS Manager

Arguments: name, last_uuid, org_dn, prefix, state, first_uuid, order, description

Configures server UUID pools and UUID blocks on Cisco UCS Manager. Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).

Ucs Vhba Template *arguments

Configures vHBA templates on Cisco UCS Manager

Arguments: redundancy_type, fabric, stats_policy, org_dn, name, template_type, max_data, state, wwpn_pool, pin_group, qos_policy, vsan, description

Configures vHBA templates on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Vlan Find *arguments

Find VLANs on Cisco UCS Manager

Arguments: pattern, fabric, vlanid

Find VLANs on Cisco UCS Manager based on different criteria.

Ucs Vlans *arguments

Configures VLANs on Cisco UCS Manager

Arguments: state, sharing, fabric, name, multicast_policy, id, native

Configures VLANs on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Vnic Template *arguments

Configures vNIC templates on Cisco UCS Manager

Arguments: redundancy_type, cdn_name, stats_policy, network_control_policy, cdn_source, description, fabric, vlans_list, name, org_dn, mtu, template_type, state, mac_pool, target, pin_group, qos_policy, peer_redundancy_template

Configures vNIC templates on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Vsans *arguments

Configures VSANs on Cisco UCS Manager

Arguments: state, fabric, vlan_id, vsan_id, fc_zoning, name

Configures VSANs on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Ucs Wwn Pool *arguments

Configures WWNN or WWPN pools on Cisco UCS Manager

Arguments: description, last_addr, org_dn, first_addr, state, purpose, order, name

Configures WWNNs or WWPN pools on Cisco UCS Manager. Examples can be used with the UCS Platform Emulator U(https://communities.cisco.com/ucspe).

Udm Dns Record *arguments

Manage dns entries on a univention corporate server

Arguments: type, state, data, name, zone

This module allows to manage dns records on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.

Udm Dns Zone *arguments

Manage dns zones on a univention corporate server

Arguments: retry, zone, interfaces, refresh, state, contact, expire, ttl, nameserver, type, mx

This module allows to manage dns zones on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.

Udm Group *arguments

Manage of the posix group

Arguments: state, name, position, ou, subpath, description

This module allows to manage user groups on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.

Udm Share *arguments

Manage samba shares on a univention corporate server

Arguments: samba_name, samba_hide_files, samba_blocking_locks, samba_directory_mode, samba_dos_filemode, samba_postexec, owner, samba_fake_oplocks, samba_strict_locking, samba_public, samba_force_directory_security_mode, group, samba_writeable, samba_nt_acl_support, samba_write_list, samba_preexec, samba_browseable, samba_inherit_acls, samba_msdfs_root, state, samba_valid_users, samba_force_create_mode, root_squash, samba_directory_security_mode, samba_force_group, samba_vfs_objects, samba_force_directory_mode, writeable, samba_locking, samba_security_mode, samba_inherit_owner, samba_csc_policy, sync, nfs_hosts, path, nfs_custom_settings, samba_force_user, name, samba_invalid_users, samba_create_mode, samba_force_security_mode, samba_level_2_oplocks, samba_custom_settings, samba_hide_unreadable, host, samba_block_size, samba_oplocks, samba_hosts_allow, samba_inherit_permissions, subtree_checking, directorymode, ou, samba_hosts_deny

This module allows to manage samba shares on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.

Udm User *arguments

Manage posix users on a univention corporate server

Arguments: update_password, samba_user_workstations, homedrive, room_number, primary_group, postcode, scriptpath, home_share, override_pw_history, city, display_name, pager_telephonenumber, employee_number, serviceprovider, organisation, subpath, state, home_share_path, userexpiry, unixhome, mail_home_server, email, sambahome, username, home_telephone_number, shell, description, firstname, lastname, mail_alternative_address, phone, birthday, groups, profilepath, employee_type, password, pwd_change_next_login, mail_primary_address, country, title, override_pw_length, street, gecos, mobile_telephone_number, position, ou, department_number, samba_privileges, secretary

This module allows to manage posix users on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.

Ufw *arguments

Manage firewall with UFW

Arguments: comment, direction, from_port, to_ip, to_port, from_ip, interface, name, insert, logging, log, proto, default, route, rule, insert_relative_to, state, delete

Manage firewall with UFW.

Unarchive *arguments

Unpacks an archive after (optionally) copying it from the local machine.

Arguments: src, remote_src, dest, list_files, keep_newer, creates, exclude, extra_opts, copy, validate_certs

The C(unarchive) module unpacks an archive. It will not unpack a compressed file that does not contain an archive. By default, it will copy the source file from the local system to the target before unpacking. Set C(remote_src=yes) to unpack an archive which already exists on the target. If checksum validation is desired, use M(get_url) or M(uri) instead to fetch the file and set C(remote_src=yes). For Windows targets, use the M(win_unzip) module instead.

Uptimerobot *arguments

Pause and start Uptime Robot monitoring

Arguments: monitorid, state, apikey

This module will let you start and pause Uptime Robot Monitoring

Uri *arguments

Interacts with webservices

Arguments: body, force, timeout, remote_src, dest, follow_redirects, force_basic_auth, removes, http_agent, body_format, client_key, src, use_proxy, headers, url, method, creates, unix_socket, url_password, url_username, status_code, return_content, validate_certs, client_cert

Interacts with HTTP and HTTPS web services and supports Digest, Basic and WSSE HTTP authentication mechanisms. For Windows targets, use the M(win_uri) module instead.

Urpmi *arguments

Urpmi manager

Arguments: no-recommends, force, name, update_cache, root, state

Manages packages with I(urpmi) (such as for Mageia or Mandriva)

User *arguments

Manage user accounts

Arguments: comment, ssh_key_bits, update_password, non_unique, force, skeleton, create_home, password_lock, ssh_key_passphrase, home, append, uid, ssh_key_comment, group, system, state, role, hidden, ssh_key_type, authorization, profile, shell, expires, ssh_key_file, groups, move_home, password, name, local, seuser, remove, login_class, generate_ssh_key

Manage user accounts and user attributes. For Windows targets, use the M(win_user) module instead.

Utm Aaa Group *arguments

Create, update or destroy an aaa group object in Sophos UTM.

Arguments: comment, ipsec_dn, ldap_attribute, name, adirectory_groups, dynamic, edirectory_groups, adirectory_groups_sids, ldap_attribute_value, members, tacacs_groups, backend_match, radius_groups, network

Create, update or destroy an aaa group object in Sophos UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Aaa Group Info *arguments

get info for reverse_proxy frontend entry in Sophos UTM

Arguments: name

get info for a reverse_proxy frontend entry in SOPHOS UTM.

Utm Ca Host Key Cert *arguments

create, update or destroy ca host_key_cert entry in Sophos UTM

Arguments: comment, key, meta, name, certificate, encrypted, ca

Create, update or destroy a ca host_key_cert entry in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Ca Host Key Cert Info *arguments

Get info for a ca host_key_cert entry in Sophos UTM

Arguments: name

Get info for a ca host_key_cert entry in SOPHOS UTM.

Utm Dns Host *arguments

create, update or destroy dns entry in Sophos UTM

Arguments: comment, resolved, name, resolved6, hostname, address6, timeout, address, interface

Create, update or destroy a dns entry in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Network Interface Address *arguments

Create, update or destroy network/interface_address object

Arguments: comment, resolved, name, resolved6, address, address6

Create, update or destroy a network/interface_address object in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Network Interface Address Info *arguments

Get info for a network/interface_address object

Arguments: name

Get info for a network/interface_address object in SOPHOS UTM.

Utm Proxy Auth Profile *arguments

create, update or destroy reverse_proxy auth_profile entry in Sophos UTM

Arguments: comment, frontend_session_allow_persistency, frontend_session_timeout_scope, frontend_form, logout_mode, backend_user_prefix, frontend_session_lifetime_scope, frontend_session_timeout, frontend_session_lifetime_limited, backend_mode, backend_strip_basic_auth, logout_delegation_urls, frontend_mode, frontend_cookie, frontend_logout, aaa, name, frontend_realm, frontend_session_timeout_enabled, frontend_login, basic_prompt, frontend_session_lifetime, backend_user_suffix, frontend_form_template, redirect_to_requested_url, frontend_cookie_secret

Create, update or destroy a reverse_proxy auth_profile entry in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Proxy Exception *arguments

Create, update or destroy reverse_proxy exception entry in Sophos UTM

Arguments: status, skipav, skipbadclients, name, skipform, skipcookie, skipurl, skiptft, skipform_missingtoken, source, skiphtmlrewrite, skip_threats_filter_categories, skip_custom_threats_filters, path, op

Create, update or destroy a reverse_proxy exception entry in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Proxy Frontend *arguments

create, update or destroy reverse_proxy frontend entry in Sophos UTM

Arguments: comment, profile, domain, allowed_networks, implicitredirect, locations, disable_compression, preservehost, address, port, htmlrewrite, name, certificate, xheaders, status, add_content_type_header, htmlrewrite_cookies, exceptions, type, lbmethod

Create, update or destroy a reverse_proxy frontend entry in Sophos UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Proxy Frontend Info *arguments

create, update or destroy reverse_proxy frontend entry in Sophos UTM

Arguments: name

Create, update or destroy a reverse_proxy frontend entry in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Proxy Location *arguments

create, update or destroy reverse_proxy location entry in Sophos UTM

Arguments: comment, hot_standby, name, denied_networks, stickysession_id, auth_profile, websocket_passthrough, status, stickysession_status, access_control, path, be_path, allowed_networks, backend

Create, update or destroy a reverse_proxy location entry in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Utm Proxy Location Info *arguments

create, update or destroy reverse_proxy location entry in Sophos UTM

Arguments: name

Create, update or destroy a reverse_proxy location entry in SOPHOS UTM. This module needs to have the REST Ability of the UTM to be activated.

Vca Fw *arguments

add remove firewall rules in a gateway in a vca

Arguments: fw_rules

Adds or removes firewall rules from a gateway in a vca environment

Vca Nat *arguments

add remove nat rules in a gateway in a vca

Arguments: nat_rules, purge_rules

Adds or removes nat rules from a gateway in a vca environment

Vca Vapp *arguments

Manages vCloud Air vApp instances.

Arguments: vm_name, username, vm_memory, template_name, network_mode, vapp_name, org, operation, password, vm_cpus, vdc_name, network_name, host, instance_id, state, service_type, api_version

This module will actively managed vCloud Air vApp instances. Instances can be created and deleted as well as both deployed and undeployed.

Vcenter Extension *arguments

Register/deregister vCenter Extensions

Arguments: extension_key, name, server_type, url, company, email, visible, state, version, client_type, ssl_thumbprint, description

This module can be used to register/deregister vCenter Extensions.

Vcenter Extension Info *arguments

Gather info vCenter extensions

Arguments:

This module can be used to gather information about vCenter extension.

Vcenter Folder *arguments

Manage folders on given datacenter

Arguments: folder_type, datacenter, parent_folder, folder_name, state

This module can be used to create, delete, move and rename folder on then given datacenter. This module is only supported for vCenter.

Vcenter License *arguments

Manage VMware vCenter license keys

Arguments: cluster_name, datacenter, state, esxi_hostname, license, labels

Add and delete vCenter, ESXi server license keys.

Vdirect Commit *arguments

Commits pending configuration changes on Radware devices

Arguments: vdirect_user, vdirect_wait, vdirect_https_port, vdirect_timeout, vdirect_http_port, vdirect_ip, devices, sync, apply, vdirect_secondary_ip, save, validate_certs, vdirect_use_ssl, vdirect_password

Commits pending configuration changes on one or more Radware devices via vDirect server. For Alteon ADC device, apply, sync and save actions will be performed by default. Skipping of an action is possible by explicit parameter specifying. For Alteon VX Container device, no sync operation will be performed since sync action is only relevant for Alteon ADC devices. For DefensePro and AppWall devices, a bulk commit action will be performed. Explicit apply, sync and save actions specifying is not relevant.

Vdirect File *arguments

Uploads a new or updates an existing runnable file into Radware vDirect server

Arguments: vdirect_user, vdirect_wait, vdirect_https_port, file_name, vdirect_timeout, vdirect_http_port, vdirect_ip, vdirect_secondary_ip, validate_certs, vdirect_use_ssl, vdirect_password

Uploads a new or updates an existing configuration template or workflow template into the Radware vDirect server. All parameters may be set as environment variables.

Vdirect Runnable *arguments

Runs templates and workflow actions in Radware vDirect server

Arguments: vdirect_user, vdirect_wait, runnable_name, parameters, vdirect_https_port, vdirect_timeout, vdirect_http_port, vdirect_ip, action_name, runnable_type, vdirect_secondary_ip, validate_certs, vdirect_use_ssl, vdirect_password

Runs configuration templates, creates workflows and runs workflow actions in Radware vDirect server.

Vdo *arguments

Module to control VDO

Arguments: readcachesize, ackthreads, biothreads, activated, running, emulate512, indexmem, device, logicalthreads, blockmapcachesize, name, writepolicy, compression, deduplication, physicalthreads, state, readcache, logicalsize, growphysical, indexmode, slabsize, cputhreads

This module controls the VDO dedupe and compression device. VDO, or Virtual Data Optimizer, is a device-mapper target that provides inline block-level deduplication, compression, and thin provisioning capabilities to primary storage.

Vertica Configuration *arguments

Updates Vertica configuration parameters.

Arguments: cluster, name, login_password, login_user, db, port, value

Updates Vertica configuration parameters.

Vertica Info *arguments

Gathers Vertica database facts.

Arguments: login_user, cluster, db, port, login_password

Gathers Vertica database information. This module was called C(vertica_facts) before Ansible 2.9, returning C(ansible_facts). Note that the M(vertica_info) module no longer returns C(ansible_facts)!

Vertica Role *arguments

Adds or removes Vertica database roles and assigns roles to them.

Arguments: assigned_roles, name, login_user, db, cluster, state, login_password, port

Adds or removes Vertica database role and, optionally, assign other roles.

Vertica Schema *arguments

Adds or removes Vertica database schema and roles.

Arguments: create_roles, name, login_user, db, usage_roles, cluster, state, login_password, owner, port

Adds or removes Vertica database schema and, optionally, roles with schema access privileges. A schema will not be removed until all the objects have been dropped. In such a situation, if the module tries to remove the schema it will fail and only remove roles created for the schema if they have no dependencies.

Vertica User *arguments

Adds or removes Vertica database users and assigns roles.

Arguments: profile, resource_pool, name, roles, login_user, ldap, db, cluster, state, login_password, password, expired, port

Adds or removes Vertica database user and, optionally, assigns roles. A user will not be removed until all the dependencies have been dropped. In such a situation, if the module tries to remove the user it will fail and only remove roles granted to the user.

Vexata Eg *arguments

Manage export groups on Vexata VX100 storage arrays

Arguments: state, vg, pg, ig, name

Create or delete export groups on a Vexata VX100 array. An export group is a tuple of a volume group, initiator group and port group that allows a set of volumes to be exposed to one or more hosts through specific array ports.

Vexata Volume *arguments

Manage volumes on Vexata VX100 storage arrays

Arguments: state, name, size

Create, deletes or extend volumes on a Vexata VX100 array.

Virt *arguments

Manages virtual machines supported by libvirt

Arguments: xml, state, command, name, autostart, uri

Manages virtual machines supported by I(libvirt).

Virt Net *arguments

Manage libvirt network configuration

Arguments: xml, state, command, name, autostart, uri

Manage I(libvirt) networks.

Virt Pool *arguments

Manage libvirt storage pools

Arguments: xml, state, command, name, autostart, uri, mode

Manage I(libvirt) storage pools.

Vmadm *arguments

Manage SmartOS virtual machines and zones.

Arguments: customer_metadata, disk_driver, force, zfs_root_compression, virtio_txtimer, spice_password, zfs_io_priority, ram, dns_domain, max_physical_memory, nic_driver, zfs_data_compression, image_uuid, fs_allowed, indestructible_delegated, qemu_opts, delegate_dataset, firewall_enabled, mdata_exec_timeout, archive_on_delete, nics, hostname, boot, vga, zfs_snapshot_limit, state, limit_priv, cpu_cap, maintain_resolvers, indestructible_zoneroot, vnc_password, vcpus, disks, max_swap, zfs_root_recsize, brand, zfs_filesystem_limit, quota, filesystems, autoboot, tmpfs, qemu_extra_opts, resolvers, max_lwps, nowait, name, kernel_version, max_locked_memory, vnc_port, uuid, internal_metadata_namespace, virtio_txburst, spice_opts, zfs_data_recsize, internal_metadata, cpu_type, routes, zpool, docker, cpu_shares

Manage SmartOS virtual machines through vmadm(1M).

Vmware About Info *arguments

Provides information about VMware server to which user is connecting to

Arguments:

This module can be used to gather information about VMware server to which user is trying to connect.

Vmware Category *arguments

Manage VMware categories

Arguments: new_category_name, category_cardinality, state, category_name, category_description

This module can be used to create / delete / update VMware categories. Tag feature is introduced in vSphere 6 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive.

Vmware Category Info *arguments

Gather info about VMware tag categories

Arguments:

This module can be used to gather information about VMware tag categories. Tag feature is introduced in vSphere 6 version, so this module is not supported in earlier versions of vSphere. All variables and VMware object names are case sensitive.

Vmware Cfg Backup *arguments

Backup / Restore / Reset ESXi host configuration

Arguments: dest, src, state, esxi_hostname

This module can be used to perform various operations related to backup, restore and reset of ESXi host configuration.

Vmware Cluster *arguments

Manage VMware vSphere clusters

Arguments: ha_restart_priority, ha_vm_max_failures, ha_host_monitoring, vsan_auto_claim_storage, enable_drs, ha_failover_level, ignore_drs, drs_vmotion_rate, enable_ha, datacenter, enable_vsan, ha_vm_failure_interval, ha_vm_monitoring, state, cluster_name, drs_enable_vm_behavior_overrides, ha_admission_control_enabled, ignore_ha, ignore_vsan, drs_default_vm_behavior, ha_vm_max_failure_window, ha_vm_min_up_time

Adds or removes VMware vSphere clusters. Although this module can manage DRS, HA and VSAN related configurations, this functionality is deprecated and will be removed in 2.12. To manage DRS, HA and VSAN related configurations, use the new modules vmware_cluster_drs, vmware_cluster_ha and vmware_cluster_vsan. All values and VMware object names are case sensitive.

Vmware Cluster Drs *arguments

Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters

Arguments: cluster_name, datacenter, drs_enable_vm_behavior_overrides, enable_drs, drs_vmotion_rate, drs_default_vm_behavior

Manages DRS on VMware vSphere clusters. All values and VMware object names are case sensitive.

Vmware Cluster Ha *arguments

Manage High Availability (HA) on VMware vSphere clusters

Arguments: enable_ha, datacenter, ha_restart_priority, failover_host_admission_control, ha_host_monitoring, ha_vm_failure_interval, slot_based_admission_control, ha_vm_monitoring, cluster_name, reservation_based_admission_control, host_isolation_response, ha_vm_max_failures, ha_vm_max_failure_window, ha_vm_min_up_time

Manages HA configuration on VMware vSphere clusters. All values and VMware object names are case sensitive.

Vmware Cluster Info *arguments

Gather info about clusters available in given vCenter

Arguments: cluster_name, datacenter, show_tag

This module can be used to gather information about clusters in VMWare infrastructure. All values and VMware object names are case sensitive. This module was called C(vmware_cluster_facts) before Ansible 2.9. The usage did not change.

Vmware Cluster Vsan *arguments

Manages virtual storage area network (vSAN) configuration on VMware vSphere clusters

Arguments: cluster_name, datacenter, enable_vsan, vsan_auto_claim_storage

Manages vSAN on VMware vSphere clusters. All values and VMware object names are case sensitive.

Vmware Content Deploy Template *arguments

Deploy Virtual Machine from template stored in content library.

Arguments: resource_pool, datacenter, name, host, cluster, state, template, datastore, folder

Module to deploy virtual machine from template in content library. Content Library feature is introduced in vSphere 6.0 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive.

Vmware Content Library Info *arguments

Gather information about VMware Content Library

Arguments: library_id

Module to list the content libraries. Module to get information about specific content library. Content Library feature is introduced in vSphere 6.0 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive.

Vmware Content Library Manager *arguments

Create, update and delete VMware content library

Arguments: library_type, library_name, state, datastore_name, library_description

Module to manage VMware content Library Content Library feature is introduced in vSphere 6.0 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive.

Vmware Datacenter *arguments

Manage VMware vSphere Datacenters

Arguments: state, datacenter_name

This module can be used to manage (create, delete) VMware vSphere Datacenters.

Vmware Datastore Cluster *arguments

Manage VMware vSphere datastore clusters

Arguments: datastore_cluster_name, state, datacenter_name, folder

This module can be used to add and delete datastore cluster in given VMware environment. All parameters and VMware object values are case sensitive.

Vmware Datastore Info *arguments

Gather info about datastores available in given vCenter

Arguments: cluster, gather_nfs_mount_info, gather_vmfs_mount_info, name, datacenter

This module can be used to gather information about datastores in VMWare infrastructure. All values and VMware object names are case sensitive. This module was called C(vmware_datastore_facts) before Ansible 2.9. The usage did not change.

Vmware Datastore Maintenancemode *arguments

Place a datastore into maintenance mode

Arguments: cluster_name, datastore, datastore_cluster, state

This module can be used to manage maintenance mode of a datastore.

Vmware Deploy Ovf *arguments

Deploys a VMware virtual machine from an OVF or OVA file

Arguments: resource_pool, power_on, cluster, deployment_option, disk_provisioning, datastore, properties, wait_for_ip_address, fail_on_spec_warnings, datacenter, name, inject_ovf_env, networks, allow_duplicates, ovf, folder, wait

This module can be used to deploy a VMware VM from an OVF or OVA file

Vmware Dns Config *arguments

Manage VMware ESXi DNS Configuration

Arguments: change_hostname_to, dns_servers, domainname

Manage VMware ESXi DNS Configuration

Vmware Drs Group *arguments

Creates vm/host group in a given cluster.

Arguments: cluster_name, datacenter, state, hosts, vms, group_name

This module can be used to create VM/Host groups in a given cluster. Creates a vm group if C(vms) is set. Creates a host group if C(hosts) is set.

Vmware Drs Group Info *arguments

Gathers info about DRS VM/Host groups on the given cluster

Arguments: cluster_name, datacenter

This module can be used to gather information about DRS VM/HOST groups from the given cluster.

Vmware Drs Rule Info *arguments

Gathers info about DRS rule on the given cluster

Arguments: cluster_name, datacenter

This module can be used to gather information about DRS VM-VM and VM-HOST rules from the given cluster.

Vmware Dvs Host *arguments

Add or remove a host from distributed virtual switch

Arguments: vmnics, state, vendor_specific_config, switch_name, esxi_hostname

Manage a host system from distributed virtual switch.

Vmware Dvs Portgroup *arguments

Create or remove a Distributed vSwitch portgroup.

Arguments: portgroup_name, teaming_policy, port_policy, network_policy, state, num_ports, vlan_id, portgroup_type, switch_name, vlan_trunk

Create or remove a Distributed vSwitch portgroup.

Vmware Dvs Portgroup Find *arguments

Find portgroup(s) in a VMware environment

Arguments: dvswitch, show_uplink, vlanid, name

Find portgroup(s) based on different criteria such as distributed vSwitch, VLAN id or a string in the name.

Vmware Dvs Portgroup Info *arguments

Gathers info DVS portgroup configurations

Arguments: datacenter, show_vlan_info, show_teaming_policy, show_port_policy, dvswitch, show_network_policy

This module can be used to gather information about DVS portgroup configurations.

Vmware Dvswitch *arguments

Create or remove a Distributed Switch

Arguments: health_check, datacenter_name, multicast_filtering_mode, discovery_proto, mtu, state, contact, uplink_prefix, switch_version, folder, discovery_operation, switch_name, uplink_quantity, description

This module can be used to create, remove a Distributed Switch.

Vmware Dvswitch Lacp *arguments

Manage LACP configuration on a Distributed Switch

Arguments: switch, support_mode, link_aggregation_groups

This module can be used to configure Link Aggregation Control Protocol (LACP) support mode and Link Aggregation Groups (LAGs).

Vmware Dvswitch Nioc *arguments

Manage distributed switch Network IO Control

Arguments: switch, version, state, resources

This module can be used to manage distributed switch Network IO Control configurations.

Vmware Dvswitch Pvlans *arguments

Manage Private VLAN configuration of a Distributed Switch

Arguments: switch, primary_pvlans, secondary_pvlans

This module can be used to configure Private VLANs (PVLANs) on a Distributed Switch.

Vmware Dvswitch Uplink Pg *arguments

Manage uplink portproup configuration of a Distributed Switch

Arguments: vlan_trunk_range, name, netflow_enabled, lacp, switch, block_all_ports, advanced, description

This module can be used to configure the uplink portgroup of a Distributed Switch.

Vmware Evc Mode *arguments

Enable/Disable EVC mode on vCenter

Arguments: cluster_name, state, datacenter_name, evc_mode

This module can be used to enable/disable EVC mode on vCenter.

Vmware Export Ovf *arguments

Exports a VMware virtual machine to an OVF file, device files and a manifest file

Arguments: export_with_images, datacenter, export_dir, name, download_timeout, moid, folder, uuid

This module can be used to export a VMware virtual machine to OVF template from vCenter server or ESXi host.

Vmware Folder Info *arguments

Provides information about folders in a datacenter

Arguments: datacenter

The module can be used to gather a hierarchical view of the folders that exist within a datacenter

Vmware Guest *arguments

Manages virtual machines in vCenter

Arguments: resource_pool, snapshot_src, force, esxi_hostname, name, datacenter, customization_spec, hardware, cluster, wait_for_customization, name_match, customization, cdrom, state_change_timeout, datastore, disk, networks, wait_for_ip_address, guest_id, convert, uuid, is_template, customvalues, state, annotation, vapp_properties, use_instance_uuid, template, linked_clone, folder

This module can be used to create new virtual machines from templates or other virtual machines, manage power state of virtual machine such as power on, power off, suspend, shutdown, reboot, restart etc., modify various virtual machine components like network, disk, customization etc., rename a virtual machine and remove a virtual machine with associated components.

Vmware Guest Boot Info *arguments

Gather info about boot options for the given virtual machine

Arguments: use_instance_uuid, uuid, moid, name, name_match

Gather information about boot options for the given virtual machine.

Vmware Guest Boot Manager *arguments

Manage boot options for the given virtual machine

Arguments: secure_boot_enabled, name, boot_order, boot_retry_delay, boot_delay, use_instance_uuid, enter_bios_setup, moid, name_match, boot_retry_enabled, boot_firmware, uuid

This module can be used to manage boot options for the given virtual machine.

Vmware Guest Custom Attribute Defs *arguments

Manage custom attributes definitions for virtual machine from VMware

Arguments: attribute_key, state

This module can be used to add and remove custom attributes definitions for the given virtual machine from VMware.

Vmware Guest Custom Attributes *arguments

Manage custom attributes from VMware for the given virtual machine

Arguments: datacenter, name, use_instance_uuid, state, moid, attributes, folder, uuid

This module can be used to add, remove and update custom attributes for the given virtual machine.

Vmware Guest Customization Info *arguments

Gather info about VM customization specifications

Arguments: spec_name

This module can be used to gather information about customization specifications. All parameters and VMware object names are case sensitive.

Vmware Guest Disk *arguments

Manage disks related to virtual machine in given vCenter infrastructure

Arguments: use_instance_uuid, datacenter, moid, name, folder, disk, uuid

This module can be used to add, remove and update disks belonging to given virtual machine. All parameters and VMware object names are case sensitive. This module is destructive in nature, please read documentation carefully before proceeding. Be careful while removing disk specified as this may lead to data loss.

Vmware Guest Disk Info *arguments

Gather info about disks of given virtual machine

Arguments: use_instance_uuid, datacenter, moid, name, folder, uuid

This module can be used to gather information about disks belonging to given virtual machine. All parameters and VMware object names are case sensitive.

Vmware Guest File Operation *arguments

Files operation in a VMware guest operating system without network

Arguments: datacenter, vm_password, vm_username, cluster, vm_id_type, directory, folder, copy, vm_id, fetch

Module to copy a file to a VM, fetch a file from a VM and create or delete a directory in the guest OS.

Vmware Guest Find *arguments

Find the folder path(s) for a virtual machine by name or UUID

Arguments: use_instance_uuid, datacenter, name, uuid

Find the folder path(s) for a virtual machine by name or UUID

Vmware Guest Info *arguments

Gather info about a single VM

Arguments: datacenter, uuid, tags, name, use_instance_uuid, moid, name_match, folder, properties, schema

Gather information about a single VM on a VMware ESX cluster. This module was called C(vmware_guest_facts) before Ansible 2.9. The usage did not change.

Vmware Guest Move *arguments

Moves virtual machines in vCenter

Arguments: dest_folder, datacenter, moid, name, use_instance_uuid, uuid, name_match

This module can be used to move virtual machines between folders.

Vmware Guest Network *arguments

Manage network adapters of specified virtual machine in given vCenter infrastructure

Arguments: datacenter, name, gather_network_info, cluster, moid, esxi_hostname, folder, networks, uuid

This module is used to add, reconfigure, remove network adapter of given virtual machine. All parameters and VMware object names are case sensitive.

Vmware Guest Powerstate *arguments

Manages power states of virtual machines in vCenter

Arguments: state_change_timeout, force, uuid, name, schedule_task_description, schedule_task_name, use_instance_uuid, state, moid, name_match, folder, schedule_task_enabled, scheduled_at

Power on / Power off / Restart a virtual machine.

Vmware Guest Screenshot *arguments

Create a screenshot of the Virtual Machine console.

Arguments: datacenter, name, moid, cluster, local_path, esxi_hostname, folder, uuid

This module is used to take screenshot of the given virtual machine when virtual machine is powered on. All parameters and VMware object names are case sensitive.

Vmware Guest Sendkey *arguments

Send USB HID codes to the Virtual Machine's keyboard.

Arguments: datacenter, name, string_send, cluster, moid, esxi_hostname, keys_send, folder, uuid

This module is used to send keystrokes to given virtual machine. All parameters and VMware object names are case sensitive.

Vmware Guest Snapshot *arguments

Manages virtual machines snapshots in vCenter

Arguments: datacenter, new_snapshot_name, uuid, state, quiesce, memory_dump, name, use_instance_uuid, new_description, moid, name_match, snapshot_name, remove_children, folder, description

This module can be used to create, delete and update snapshot(s) of the given virtual machine. All parameters and VMware object names are case sensitive.

Vmware Guest Snapshot Info *arguments

Gather info about virtual machine's snapshots in vCenter

Arguments: use_instance_uuid, datacenter, moid, name, folder, uuid

This module can be used to gather information about virtual machine's snapshots. This module was called C(vmware_guest_snapshot_facts) before Ansible 2.9. The usage did not change.

Vmware Guest Tools Upgrade *arguments

Module to upgrade VMTools

Arguments: datacenter, moid, uuid, name, folder, name_match

This module upgrades the VMware Tools on Windows and Linux guests.

Vmware Guest Tools Wait *arguments

Wait for VMware tools to become available

Arguments: use_instance_uuid, moid, uuid, name, folder, name_match

This module can be used to wait for VMware tools to become available on the given VM and return facts.

Vmware Guest Video *arguments

Modify video card configurations of specified virtual machine in given vCenter infrastructure

Arguments: datacenter, enable_3D, name, use_auto_detect, uuid, renderer_3D, video_memory_mb, moid, display_number, folder, gather_video_facts, memory_3D_mb

This module is used to reconfigure video card settings of given virtual machine. All parameters and VMware object names are case sensitive.

Vmware Guest Vnc *arguments

Manages VNC remote display on virtual machines in vCenter

Arguments: datacenter, uuid, moid, vnc_port, state, vnc_ip, name_match, folder, vnc_password, name

This module can be used to enable and disable VNC remote display on virtual machine.

Vmware Host *arguments

Add, remove, or move an ESXi host to, from, or within vCenter

Arguments: datacenter_name, esxi_hostname, force_connection, esxi_username, esxi_ssl_thumbprint, cluster_name, state, add_connected, esxi_password, folder, fetch_ssl_thumbprint, reconnect_disconnected

This module can be used to add, reconnect, or remove an ESXi host to or from vCenter. This module can also be used to move an ESXi host to a cluster or folder, or vice versa, within the same datacenter.

Vmware Host Acceptance *arguments

Manage the host acceptance level of an ESXi host

Arguments: cluster_name, state, esxi_hostname, acceptance_level

This module can be used to manage the host acceptance level of an ESXi host. The host acceptance level controls the acceptance level of each VIB on a ESXi host.

Vmware Host Active Directory *arguments

Joins an ESXi host system to an Active Directory domain or leaves it

Arguments: cluster_name, esxi_hostname, ad_state, ad_password, ad_user, ad_domain

This module can be used to join or leave an ESXi host to or from an Active Directory domain.

Vmware Host Capability Info *arguments

Gathers info about an ESXi host's capability information

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about an ESXi host's capability information when ESXi hostname or Cluster name is given.

Vmware Host Config Info *arguments

Gathers info about an ESXi host's advance configuration information

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about an ESXi host's advance configuration information when ESXi hostname or Cluster name is given.

Vmware Host Config Manager *arguments

Manage advanced system settings of an ESXi host

Arguments: cluster_name, options, esxi_hostname

This module can be used to manage advanced system settings of an ESXi host when ESXi hostname or Cluster name is given.

Vmware Host Datastore *arguments

Manage a datastore on ESXi host

Arguments: datacenter_name, vmfs_version, nfs_path, nfs_ro, state, esxi_hostname, datastore_type, nfs_server, vmfs_device_name, datastore_name

This module can be used to mount/umount datastore on ESXi host. This module only supports NFS (NFS v3 or NFS v4.1) and VMFS datastores. For VMFS datastore, available device must already be connected on ESXi host. All parameters and VMware object names are case sensitive.

Vmware Host Dns Info *arguments

Gathers info about an ESXi host's DNS configuration information

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about an ESXi host's DNS configuration information when ESXi hostname or Cluster name is given. All parameters and VMware object names are case sensitive.

Vmware Host Facts *arguments

Gathers facts about remote ESXi hostsystem

Arguments: esxi_hostname, show_tag

This module can be used to gathers facts like CPU, memory, datastore, network and system etc. about ESXi host system. Please specify hostname or IP address of ESXi host system as C(hostname). If hostname or IP address of vCenter is provided as C(hostname) and C(esxi_hostname) is not specified, then the module will throw an error. VSAN facts added in 2.7 version.

Vmware Host Feature Info *arguments

Gathers info about an ESXi host's feature capability information

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about an ESXi host's feature capability information when ESXi hostname or Cluster name is given.

Vmware Host Firewall Info *arguments

Gathers info about an ESXi host's firewall configuration information

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about an ESXi host's firewall configuration information when ESXi hostname or Cluster name is given.

Vmware Host Firewall Manager *arguments

Manage firewall configurations about an ESXi host

Arguments: cluster_name, rules, esxi_hostname

This module can be used to manage firewall configurations about an ESXi host when ESXi hostname or Cluster name is given.

Vmware Host Hyperthreading *arguments

Enables/Disables Hyperthreading optimization for an ESXi host system

Arguments: cluster_name, state, esxi_hostname

This module can be used to enable or disable Hyperthreading optimization for ESXi host systems in given vCenter infrastructure. It also checks if Hyperthreading is activated/deactivated and if the host needs to be restarted. The module informs the user if Hyperthreading is enabled but inactive because the processor is vulnerable to L1 Terminal Fault (L1TF).

Vmware Host Ipv6 *arguments

Enables/Disables IPv6 support for an ESXi host system

Arguments: cluster_name, state, esxi_hostname

This module can be used to enable or disable IPv6 support for ESXi host systems in given vCenter infrastructure. It also checks if the host needs to be restarted.

Vmware Host Kernel Manager *arguments

Manage kernel module options on ESXi hosts

Arguments: cluster_name, kernel_module_option, esxi_hostname, kernel_module_name

This module can be used to manage kernel module options on ESXi hosts. All connected ESXi hosts in scope will be configured when specified. If a host is not connected at time of configuration, it will be marked as such in the output. Kernel module options may require a reboot to take effect which is not covered here. You can use M(reboot) or M(vmware_host_powerstate) module to reboot all ESXi host systems.

Vmware Host Lockdown *arguments

Manage administrator permission for the local administrative account for the ESXi host

Arguments: cluster_name, state, esxi_hostname

This module can be used to manage administrator permission for the local administrative account for the host when ESXi hostname is given. All parameters and VMware objects values are case sensitive. This module is destructive as administrator permission are managed using APIs used, please read options carefully and proceed. Please specify C(hostname) as vCenter IP or hostname only, as lockdown operations are not possible from standalone ESXi server.

Vmware Host Ntp *arguments

Manage NTP server configuration of an ESXi host

Arguments: cluster_name, ntp_servers, state, verbose, esxi_hostname

This module can be used to configure, add or remove NTP servers from an ESXi host. If C(state) is not given, the NTP servers will be configured in the exact sequence. User can specify an ESXi hostname or Cluster name. In case of cluster name, all ESXi hosts are updated.

Vmware Host Ntp Info *arguments

Gathers info about NTP configuration on an ESXi host

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about NTP configurations on an ESXi host.

Vmware Host Package Info *arguments

Gathers info about available packages on an ESXi host

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about available packages and their status on an ESXi host.

Vmware Host Powermgmt Policy *arguments

Manages the Power Management Policy of an ESXI host system

Arguments: policy, cluster_name, esxi_hostname

This module can be used to manage the Power Management Policy of ESXi host systems in given vCenter infrastructure.

Vmware Host Powerstate *arguments

Manages power states of host systems in vCenter

Arguments: cluster_name, state, force, esxi_hostname, timeout

This module can be used to manage power states of host systems in given vCenter infrastructure. User can set power state to 'power-down-to-standby', 'power-up-from-standby', 'shutdown-host' and 'reboot-host'. State 'reboot-host', 'shutdown-host' and 'power-down-to-standby' are not supported by all the host systems.

Vmware Host Scanhba *arguments

Rescan host HBA's and optionally refresh the storage system

Arguments: cluster_name, refresh_storage, esxi_hostname

This module can force a rescan of the hosts HBA subsystem which is needed when wanting to mount a new datastore. You could use this before using M(vmware_host_datastore) to mount a new datastore to ensure your device/volume is ready. You can also optionally force a Refresh of the Storage System in vCenter/ESXi Web Client. All parameters and VMware object names are case sensitive. You can supply an esxi_hostname or a cluster_name

Vmware Host Service Info *arguments

Gathers info about an ESXi host's services

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about an ESXi host's services.

Vmware Host Service Manager *arguments

Manage services on a given ESXi host

Arguments: cluster_name, service_name, state, service_policy, esxi_hostname

This module can be used to manage (start, stop, restart) services on a given ESXi host. If cluster_name is provided, specified service will be managed on all ESXi host belonging to that cluster. If specific esxi_hostname is provided, then specified service will be managed on given ESXi host only.

Vmware Host Snmp *arguments

Configures SNMP on an ESXi host system

Arguments: hw_source, log_level, snmp_port, state, community, trap_targets, send_trap, trap_filter

This module can be used to configure the embedded SNMP agent on an ESXi host.

Vmware Host Ssl Info *arguments

Gather info of ESXi host system about SSL

Arguments: cluster_name, esxi_hostname

This module can be used to gather information of the SSL thumbprint information for a host.

Vmware Host Vmhba Info *arguments

Gathers info about vmhbas available on the given ESXi host

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about vmhbas available on the given ESXi host. If C(cluster_name) is provided, then vmhba information about all hosts from given cluster will be returned. If C(esxi_hostname) is provided, then vmhba information about given host system will be returned.

Vmware Host Vmnic Info *arguments

Gathers info about vmnics available on the given ESXi host

Arguments: directpath_io, cluster_name, capabilities, sriov, esxi_hostname

This module can be used to gather information about vmnics available on the given ESXi host. If C(cluster_name) is provided, then vmnic information about all hosts from given cluster will be returned. If C(esxi_hostname) is provided, then vmnic information about given host system will be returned. Additional details about vswitch and dvswitch with respective vmnic is also provided which is added in 2.7 version.

Vmware Local Role Info *arguments

Gather info about local roles on an ESXi host

Arguments:

This module can be used to gather information about local role info on an ESXi host

Vmware Local Role Manager *arguments

Manage local roles on an ESXi host

Arguments: force_remove, local_role_name, state, local_privilege_ids, action

This module can be used to manage local roles on an ESXi host.

Vmware Local User Info *arguments

Gather info about users on the given ESXi host

Arguments:

This module can be used to gather information about users present on the given ESXi host system in VMware infrastructure. All variables and VMware object names are case sensitive. User must hold the 'Authorization.ModifyPermissions' privilege to invoke this module.

Vmware Local User Manager *arguments

Manage local users on an ESXi host

Arguments: local_user_password, local_user_description, state, local_user_name

Manage local users on an ESXi host

Vmware Maintenancemode *arguments

Place a host into maintenance mode

Arguments: esxi_hostname, state, vsan, evacuate, timeout

This module can be used for placing a ESXi host into maintenance mode. Support for VSAN compliant maintenance mode when selected.

Vmware Migrate Vmk *arguments

Migrate a VMK interface from VSS to VDS

Arguments: current_switch_name, migrate_portgroup_name, esxi_hostname, device, migrate_switch_name, current_portgroup_name

Migrate a VMK interface from VSS to VDS

Vmware Object Role Permission *arguments

Manage local roles on an ESXi host

Arguments: state, group, recursive, role, object_type, object_name, principal

This module can be used to manage object permissions on the given host.

Vmware Portgroup *arguments

Create a VMware portgroup

Arguments: traffic_shaping, switch, portgroup, cluster_name, state, hosts, teaming, security, vlan_id

Create a VMware Port Group on a VMware Standard Switch (vSS) for given ESXi host(s) or hosts of given cluster.

Vmware Portgroup Info *arguments

Gathers info about an ESXi host's Port Group configuration

Arguments: cluster_name, policies, esxi_hostname

This module can be used to gather information about an ESXi host's Port Group configuration when ESXi hostname or Cluster name is given.

Vmware Resource Pool *arguments

Add/remove resource pools to/from vCenter

Arguments: resource_pool, datacenter, cpu_reservation, mem_expandable_reservations, cpu_expandable_reservations, cluster, state, cpu_limit, mem_shares, mem_limit, mem_reservation, cpu_shares

This module can be used to add/remove a resource pool to/from vCenter

Vmware Resource Pool Info *arguments

Gathers info about resource pool information

Arguments:

This module can be used to gather information about all resource configuration information.

Vmware Tag *arguments

Manage VMware tags

Arguments: tag_name, category_id, tag_description, state

This module can be used to create / delete / update VMware tags. Tag feature is introduced in vSphere 6 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive.

Vmware Tag Info *arguments

Manage VMware tag info

Arguments:

This module can be used to collect information about VMware tags. Tag feature is introduced in vSphere 6 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive. This module was called C(vmware_tag_facts) before Ansible 2.9. The usage did not change.

Vmware Tag Manager *arguments

Manage association of VMware tags with VMware objects

Arguments: state, object_type, tag_names, object_name

This module can be used to assign / remove VMware tags from the given VMware objects. Tag feature is introduced in vSphere 6 version, so this module is not supported in the earlier versions of vSphere. All variables and VMware object names are case sensitive.

Vmware Target Canonical Info *arguments

Return canonical (NAA) from an ESXi host system

Arguments: cluster_name, target_id, esxi_hostname

This module can be used to gather information about canonical (NAA) from an ESXi host based on SCSI target ID.

Vmware Vcenter Settings *arguments

Configures general settings on a vCenter server

Arguments: timeout_settings, runtime_settings, user_directory, database, mail, logging_options, snmp_receivers

This module can be used to configure the vCenter server general settings (except the statistics). The statistics can be configured with the module C(vmware_vcenter_statistics).

Vmware Vcenter Statistics *arguments

Configures statistics on a vCenter server

Arguments: interval_past_day, interval_past_month, interval_past_year, interval_past_week

This module can be used to configure the vCenter server statistics. The remaining settings can be configured with the module C(vmware_vcenter_settings).

Vmware Vm Host Drs Rule *arguments

Creates vm/host group in a given cluster

Arguments: datacenter, mandatory, host_group_name, enabled, vm_group_name, affinity_rule, state, drs_rule_name, cluster_name

This module can be used to create VM-Host rules in a given cluster.

Vmware Vm Info *arguments

Return basic info pertaining to a VMware machine guest

Arguments: folder, show_attribute, vm_type, show_tag

Return basic information pertaining to a vSphere or ESXi virtual machine guest. Cluster name as fact is added in version 2.7. This module was called C(vmware_vm_facts) before Ansible 2.9. The usage did not change.

Vmware Vm Shell *arguments

Run commands in a VMware guest operating system

Arguments: datacenter, vm_password, vm_id_type, vm_shell, vm_shell_cwd, vm_shell_args, vm_username, vm_shell_env, cluster, wait_for_process, timeout, folder, vm_id

Module allows user to run common system administration commands in the guest operating system.

Vmware Vm Storage Policy Info *arguments

Gather information about vSphere storage profile defined storage policy information.

Arguments:

Returns basic information on vSphere storage profiles. A vSphere storage profile defines storage policy information that describes storage requirements for virtual machines and storage capabilities of storage providers.

Vmware Vm Vm Drs Rule *arguments

Configure VMware DRS Affinity rule for virtual machine in given cluster

Arguments: cluster_name, drs_rule_name, state, mandatory, affinity_rule, enabled, vms

This module can be used to configure VMware DRS Affinity rule for virtual machine in given cluster.

Vmware Vm Vss Dvs Migrate *arguments

Migrates a virtual machine from a standard vswitch to distributed

Arguments: vm_name, dvportgroup_name

Migrates a virtual machine from a standard vswitch to distributed

Vmware Vmkernel *arguments

Manages a VMware VMkernel Adapter of an ESXi host.

Arguments: enable_replication_nfc, enable_vmotion, vswitch_name, subnet_mask, device, ip_address, enable_provisioning, portgroup_name, enable_vsan, network, mtu, enable_mgmt, state, esxi_hostname, enable_replication, dvswitch_name, enable_ft

This module can be used to manage the VMKernel adapters / VMKernel network interfaces of an ESXi host. The module assumes that the host is already configured with the Port Group in case of a vSphere Standard Switch (vSS). The module assumes that the host is already configured with the Distributed Port Group in case of a vSphere Distributed Switch (vDS). The module automatically migrates the VMKernel adapter from vSS to vDS or vice versa if present.

Vmware Vmkernel Info *arguments

Gathers VMKernel info about an ESXi host

Arguments: cluster_name, esxi_hostname

This module can be used to gather VMKernel information about an ESXi host from given ESXi hostname or cluster name.

Vmware Vmkernel Ip Config *arguments

Configure the VMkernel IP Address

Arguments: vmk_name, ip_address, subnet_mask

Configure the VMkernel IP Address

Vmware Vmotion *arguments

Move a virtual machine using vMotion, and/or its vmdks using storage vMotion.

Arguments: vm_name, use_instance_uuid, moid, vm_uuid, destination_datastore, destination_host

Using VMware vCenter, move a virtual machine using vMotion to a different host, and/or its vmdks to another datastore using storage vMotion.

Vmware Vsan Cluster *arguments

Configure VSAN clustering on an ESXi host

Arguments: cluster_uuid

This module can be used to configure VSAN clustering on an ESXi host

Vmware Vspan Session *arguments

Create or remove a Port Mirroring session.

Arguments: destination_vm, description, session_type, normal_traffic_allowed, source_vm_received, encapsulation_vlan_id, destination_port, name, source_port_received, enabled, state, mirrored_packet_length, switch, source_port_transmitted, sampling_rate, source_vm_transmitted, strip_original_vlan

This module can be used to create, delete or edit different kind of port mirroring sessions.

Vmware Vswitch *arguments

Manage a VMware Standard Switch to an ESXi host.

Arguments: state, esxi_hostname, nics, number_of_ports, switch, mtu

This module can be used to add, remove and update a VMware Standard Switch to an ESXi host.

Vmware Vswitch Info *arguments

Gathers info about an ESXi host's vswitch configurations

Arguments: cluster_name, esxi_hostname

This module can be used to gather information about an ESXi host's vswitch configurations when ESXi hostname or Cluster name is given. The vSphere Client shows the value for the number of ports as elastic from vSphere 5.5 and above. Other tools like esxcli might show the number of ports as 1536 or 5632. See U(https://kb.vmware.com/s/article/2064511) for more details.

Voss Command *arguments

Run commands on remote devices running Extreme VOSS

Arguments: retries, commands, wait_for, match, interval

Sends arbitrary commands to an Extreme VSP device running VOSS, and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met. This module does not support running commands in configuration mode. Please use M(voss_config) to configure VOSS devices.

Voss Config *arguments

Manage Extreme VOSS configuration sections

Arguments: src, backup_options, after, lines, intended_config, diff_against, parents, save_when, defaults, before, running_config, replace, backup, match, diff_ignore_lines

Extreme VOSS configurations use a simple flat text file syntax. This module provides an implementation for working with EXOS configuration lines in a deterministic way.

Voss Facts *arguments

Collect facts from remote devices running Extreme VOSS

Arguments: gather_subset

Collects a base set of device facts from a remote device that is running VOSS. This module prepends all of the base network fact keys with C(ansible_net_<fact>). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Vsphere Copy *arguments

Copy a file to a VMware datastore

Arguments: username, src, datacenter, hostname, timeout, path, datastore, port

Upload files to a VMware datastore through a vCenter REST API.

Vsphere File *arguments

Manage files on a vCenter datastore

Arguments: username, datacenter, host, state, timeout, path, datastore, password, validate_certs

Manage files on a vCenter datastore.

Vultr Account Info *arguments

Get information about the Vultr account.

Arguments:

Get infos about account balance, charges and payments.

Vultr Block Storage *arguments

Manages block storage volumes on Vultr.

Arguments: region, size, state, name

Manage block storage volumes on Vultr.

Vultr Block Storage Info *arguments

Get information about the Vultr block storage volumes available.

Arguments:

Get infos about block storage volumes available in Vultr.

Vultr Dns Domain *arguments

Manages DNS domains on Vultr.

Arguments: state, name, server_ip

Create and remove DNS domains.

Vultr Dns Domain Info *arguments

Gather information about the Vultr DNS domains available.

Arguments:

Gather information about DNS domains available in Vultr.

Vultr Dns Record *arguments

Manages DNS records on Vultr.

Arguments: domain, multiple, name, priority, record_type, state, ttl, data

Create, update and remove DNS records.

Vultr Firewall Group *arguments

Manages firewall groups on Vultr.

Arguments: state, name

Create and remove firewall groups.

Vultr Firewall Group Info *arguments

Gather information about the Vultr firewall groups available.

Arguments:

Gather information about firewall groups available in Vultr.

Vultr Firewall Rule *arguments

Manages firewall rules on Vultr.

Arguments: state, protocol, ip_version, start_port, cidr, end_port, group

Create and remove firewall rules.

Vultr Network *arguments

Manages networks on Vultr.

Arguments: region, state, cidr, name

Manage networks on Vultr. A network cannot be updated. It needs to be deleted and re-created.

Vultr Network Info *arguments

Gather information about the Vultr networks available.

Arguments:

Gather information about networks available in Vultr.

Vultr Os Info *arguments

Get information about the Vultr OSes available.

Arguments:

Get infos about OSes available to boot servers.

Vultr Plan Info *arguments

Gather information about the Vultr plans available.

Arguments:

Gather information about plans available to boot servers.

Vultr Region Info *arguments

Gather information about the Vultr regions available.

Arguments:

Gather information about regions available to boot servers.

Vultr Server *arguments

Manages virtual servers on Vultr.

Arguments: reserved_ip_v4, force, user_data, tag, plan, ipv6_enabled, ssh_keys, private_network_enabled, name, region, hostname, firewall_group, notify_activate, state, auto_backup_enabled, snapshot, startup_script, os

Deploy, start, stop, update, restart, reinstall servers.

Vultr Server Info *arguments

Gather information about the Vultr servers available.

Arguments:

Gather information about servers available.

Vultr Ssh Key *arguments

Manages ssh keys on Vultr.

Arguments: state, name, ssh_key

Create, update and remove ssh keys.

Vultr Ssh Key Info *arguments

Get information about the Vultr SSH keys available.

Arguments:

Get infos about SSH keys available.

Vultr Startup Script *arguments

Manages startup scripts on Vultr.

Arguments: state, script_type, name, script

Create, update and remove startup scripts.

Vultr Startup Script Info *arguments

Gather information about the Vultr startup scripts available.

Arguments:

Gather information about vultr_startup_scripts available.

Vultr User *arguments

Manages users on Vultr.

Arguments: state, acls, force, name, api_enabled, password, email

Create, update and remove users.

Vultr User Info *arguments

Get information about the Vultr user available.

Arguments:

Get infos about users available in Vultr.

Vyos Banner *arguments

Manage multiline banners on VyOS devices

Arguments: text, state, banner

This will configure both pre-login and post-login banners on remote devices running VyOS. It allows playbooks to add or remote banner text from the active running configuration.

Vyos Command *arguments

Run one or more commands on VyOS devices

Arguments: retries, commands, wait_for, match, interval

The command module allows running one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully. If the conditional statements are not met in the wait period, the task fails. Certain C(show) commands in VyOS produce many lines of output and use a custom pager that can cause this module to hang. If the value of the environment variable C(ANSIBLE_VYOS_TERMINAL_LENGTH) is not set, the default number of 10000 is used.

Vyos Config *arguments

Manage VyOS configuration on remote device

Arguments: comment, src, backup_options, config, lines, save, backup, match

This module provides configuration file management of VyOS devices. It provides arguments for managing both the configuration file and state of the active configuration. All configuration statements are based on set and delete commands in the device configuration.

Vyos Facts *arguments

Get facts about vyos devices.

Arguments: gather_subset, gather_network_resources

Collects facts from network devices running the vyos operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.

Vyos Interfaces *arguments

Manages interface attributes of VyOS network devices.

Arguments: state, config

This module manages the interface attributes on VyOS network devices. This module supports managing base attributes of Ethernet, Bonding, VXLAN, Loopback and Virtual Tunnel Interfaces.

Vyos L3 Interfaces *arguments

Manages L3 interface attributes of VyOS network devices.

Arguments: state, config

This module manages the L3 interface attributes on VyOS network devices.

Vyos Lag Interfaces *arguments

Manages attributes of link aggregation groups on VyOS network devices.

Arguments: state, config

This module manages attributes of link aggregation groups on VyOS network devices.

Vyos Lldp Global *arguments

Manage link layer discovery protocol (LLDP) attributes on VyOS devices..

Arguments: state, config

This module manages link layer discovery protocol (LLDP) attributes on VyOS devices.

Vyos Lldp Interfaces *arguments

Manages attributes of lldp interfaces on VyOS devices.

Arguments: state, config

This module manages attributes of lldp interfaces on VyOS network devices.

Vyos Logging *arguments

Manage logging on network devices

Arguments: aggregate, state, name, level, dest, facility

This module provides declarative management of logging on Vyatta Vyos devices.

Vyos Ping *arguments

Tests reachability using ping from VyOS network devices

Arguments: count, source, state, ttl, dest, interval, size

Tests reachability using ping from a VyOS device to a remote destination. Tested against VyOS 1.1.8 (helium) For a general purpose network module, see the M(net_ping) module. For Windows targets, use the M(win_ping) module instead. For targets running Python, use the M(ping) module instead.

Vyos Static Route *arguments

Manage static IP routes on Vyatta VyOS network devices

Arguments: state, next_hop, aggregate, mask, prefix, admin_distance

This module provides declarative management of static IP routes on Vyatta VyOS network devices.

Vyos System *arguments

Run set system commands on VyOS devices

Arguments: name_servers, domain_name, domain_search, state, host_name

Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully.

Vyos User *arguments

Manage the collection of local users on VyOS device

Arguments: update_password, configured_password, name, level, purge, state, full_name, aggregate

This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.

Vyos Vlan *arguments

Manage VLANs on VyOS network devices

Arguments: delay, name, interfaces, purge, associated_interfaces, state, address, aggregate, vlan_id

This module provides declarative management of VLANs on VyOS network devices.

Wait For *arguments

Waits for a condition before continuing

Arguments: active_connection_states, host, connect_timeout, delay, search_regex, state, sleep, timeout, exclude_hosts, msg, path, port

You can wait for a set amount of time C(timeout), this is the default if nothing is specified or just C(timeout) is specified. This does not produce an error. Waiting for a port to become available is useful for when services are not immediately available after their init scripts return which is true of certain Java application servers. It is also useful when starting guests with the M(virt) module and needing to pause until they are ready. This module can also be used to wait for a regex match a string to be present in a file. In Ansible 1.6 and later, this module can also be used to wait for a file to be available or absent on the filesystem. In Ansible 1.8 and later, this module can also be used to wait for active connections to be closed before continuing, useful if a node is being rotated out of a load balancer pool. For Windows targets, use the M(win_wait_for) module instead.

Wait For Connection *arguments

Waits until remote system is reachable/usable

Arguments: delay, sleep, connect_timeout, timeout

Waits for a total of C(timeout) seconds. Retries the transport connection after a timeout of C(connect_timeout). Tests the transport connection every C(sleep) seconds. This module makes use of internal ansible transport (and configuration) and the ping/win_ping module to guarantee correct end-to-end functioning. This module is also supported for Windows targets.

Wakeonlan *arguments

Send a magic Wake-on-LAN (WoL) broadcast packet

Arguments: broadcast, mac, port

The C(wakeonlan) module sends magic Wake-on-LAN (WoL) broadcast packets.

Webfaction App *arguments

Add or remove applications on a Webfaction host

Arguments: name, port_open, machine, state, autostart, login_password, type, login_name, extra_info

Add or remove applications on a Webfaction host. Further documentation at U(https://github.com/quentinsf/ansible-webfaction).

Webfaction Db *arguments

Add or remove a database on Webfaction

Arguments: machine, state, name, login_password, password, type, login_name

Add or remove a database on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction.

Webfaction Domain *arguments

Add or remove domains and subdomains on Webfaction

Arguments: state, subdomains, login_name, name, login_password

Add or remove domains or subdomains on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction.

Webfaction Mailbox *arguments

Add or remove mailboxes on Webfaction

Arguments: mailbox_password, state, login_name, mailbox_name, login_password

Add or remove mailboxes on a Webfaction account. Further documentation at https://github.com/quentinsf/ansible-webfaction.

Webfaction Site *arguments

Add or remove a website on a Webfaction host

Arguments: name, host, subdomains, state, https, login_password, login_name, site_apps

Add or remove a website on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction.

Win Acl *arguments

Set file/directory/registry permissions for a system user or group

Arguments: propagation, state, user, rights, path, type, inherit

Add or remove rights/permissions for a given user or group for the specified file, folder, registry key or AppPool identifies.

Win Acl Inheritance *arguments

Change ACL inheritance

Arguments: path, state, reorganize

Change ACL (Access Control List) inheritance and optionally copy inherited ACE's (Access Control Entry) to dedicated ACE's or vice versa.

Win Audit Policy System *arguments

Used to make changes to the system wide Audit Policy

Arguments: category, audit_type, subcategory

Used to make changes to the system wide Audit Policy.

Win Audit Rule *arguments

Adds an audit rule to files, folders, or registry keys

Arguments: state, user, rights, inheritance_flags, audit_flags, path, propagation_flags

Used to apply audit rules to files, folders or registry keys. Once applied, it will begin recording the user who performed the operation defined into the Security Log in the Event viewer. The behavior is designed to ignore inherited rules since those cannot be adjusted without first disabling the inheritance behavior. It will still print inherited rules in the output though for debugging purposes.

Win Certificate Store *arguments

Manages the certificate store

Arguments: key_exportable, key_storage, file_type, store_location, store_name, state, thumbprint, path, password

Used to import/export and remove certificates and keys from the local certificate store. This module is not used to create certificates and will only manage existing certs as a file or in the store. It can be used to import PEM, DER, P7B, PKCS12 (PFX) certificates and export PEM, DER and PKCS12 certificates.

Win Chocolatey *arguments

Manage packages using chocolatey

Arguments: force, allow_prerelease, proxy_password, install_args, source_password, allow_multiple, source_username, proxy_username, skip_scripts, name, ignore_checksums, proxy_url, allow_empty_checksums, pinned, source, state, version, architecture, timeout, package_params, validate_certs, ignore_dependencies

Manage packages using Chocolatey. If Chocolatey is missing from the system, the module will install it.

Win Chocolatey Config *arguments

Manages Chocolatey config settings

Arguments: state, name, value

Used to manage Chocolatey config settings as well as unset the values.

Win Chocolatey Facts *arguments

Create a facts collection for Chocolatey

Arguments:

This module shows information from Chocolatey, such as installed packages, configuration, feature and sources.

Win Chocolatey Feature *arguments

Manages Chocolatey features

Arguments: state, name

Used to enable or disable features in Chocolatey.

Win Chocolatey Source *arguments

Manages Chocolatey sources

Arguments: source_username, allow_self_service, admin_only, name, certificate, update_password, source_password, certificate_password, priority, source, state, bypass_proxy

Used to managed Chocolatey sources configured on the client. Requires Chocolatey to be already installed on the remote host.

Win Command *arguments

Executes a command on a remote Windows node

Arguments: creates, free_form, chdir, removes, stdin

The C(win_command) module takes the command name followed by a list of space-delimited arguments. The given command will be executed on all selected nodes. It will not be processed through the shell, so variables like C($env:HOME) and operations like C("<"), C(">"), C("|"), and C(";") will not work (use the M(win_shell) module if you need these features). For non-Windows targets, use the M(command) module instead.

Win Copy *arguments

Copies files to remote locations on windows hosts

Arguments: src, force, remote_src, dest, decrypt, content, backup, local_follow

The C(win_copy) module copies a file on the local box to remote windows locations. For non-Windows targets, use the M(copy) module instead.

Win Credential *arguments

Manages Windows Credentials in the Credential Manager

Arguments: comment, username, name, secret, secret_format, alias, state, update_secret, attributes, type, persistence

Used to create and remove Windows Credentials in the Credential Manager. This module can manage both standard username/password credentials as well as certificate credentials.

Win Defrag *arguments

Consolidate fragmented files on local volumes

Arguments: priority, freespace_consolidation, include_volumes, parallel, exclude_volumes

Locates and consolidates fragmented files on local volumes to improve system performance. More information regarding C(win_defrag) is available from: U(https://technet.microsoft.com/en-us/library/cc731650(v=ws.11).aspx)

Win Disk Facts *arguments

Show the attached disks and disk information of the target host

Arguments:

With the module you can retrieve and output detailed information about the attached disks of the target and its volumes and partitions if existent.

Win Disk Image *arguments

Manage ISO/VHD/VHDX mounts on Windows hosts

Arguments: state, image_path

Manages mount behavior for a specified ISO, VHD, or VHDX image on a Windows host. When C(state) is C(present), the image will be mounted under a system-assigned drive letter, which will be returned in the C(mount_path) value of the module result. Requires Windows 8+ or Windows Server 2012+.

Win Dns Client *arguments

Configures DNS lookup on Windows hosts

Arguments: adapter_names, ipv4_addresses

The C(win_dns_client) module configures the DNS client on Windows network adapters.

Win Dns Record *arguments

Manage Windows Server DNS records

Arguments: computer_name, state, name, zone, ttl, type, value

Manage DNS records within an existing Windows Server DNS zone.

Win Domain *arguments

Ensures the existence of a Windows domain

Arguments: database_path, domain_netbios_name, create_dns_delegation, dns_domain_name, safe_mode_password, sysvol_path, forest_mode, domain_mode

Ensure that the domain named by C(dns_domain_name) exists and is reachable. If the domain is not reachable, the domain is created in a new forest on the target Windows Server 2012R2+ host. This module may require subsequent use of the M(win_reboot) action if changes are made.

Win Domain Computer *arguments

Manage computers in Active Directory

Arguments: name, domain_username, enabled, dns_hostname, sam_account_name, state, domain_password, domain_server, ou, description

Create, read, update and delete computers in Active Directory using a windows bridge computer to launch New-ADComputer, Get-ADComputer, Set-ADComputer, Remove-ADComputer and Move-ADObject powershell commands.

Win Domain Controller *arguments

Manage domain controller/member server state for a Windows host

Arguments: read_only, database_path, site_name, domain_admin_user, dns_domain_name, safe_mode_password, domain_admin_password, state, local_admin_password, sysvol_path

Ensure that a Windows Server 2012+ host is configured as a domain controller or demoted to member server. This module may require subsequent use of the M(win_reboot) action if changes are made.

Win Domain Group *arguments

Creates, modifies or removes domain groups

Arguments: category, protect, display_name, description, domain_username, ignore_protection, state, domain_password, organizational_unit, domain_server, managed_by, attributes, scope, name

Creates, modifies or removes groups in Active Directory. For local groups, use the M(win_group) module instead.

Win Domain Group Membership *arguments

Manage Windows domain group membership

Arguments: state, domain_password, name, members, domain_server, domain_username

Allows the addition and removal of domain users and domain groups from/to a domain group.

Win Domain Membership *arguments

Manage domain/workgroup membership for a Windows host

Arguments: workgroup_name, domain_ou_path, state, domain_admin_user, dns_domain_name, hostname, domain_admin_password

Manages domain membership or workgroup membership for a Windows host. Also supports hostname changes. This module may require subsequent use of the M(win_reboot) action if changes are made.

Win Domain User *arguments

Manages Windows Active Directory user accounts

Arguments: upn, update_password, surname, description, firstname, company, groups_action, password_expired, street, postal_code, groups, path, password_never_expires, account_locked, state_province, city, password, name, domain_username, country, enabled, state, domain_password, domain_server, attributes, email, user_cannot_change_password

Manages Windows Active Directory user accounts.

Win Dotnet Ngen *arguments

Runs ngen to recompile DLLs after .NET updates

Arguments:

After .NET framework is installed/updated, Windows will probably want to recompile things to optimise for the host. This happens via scheduled task, usually at some inopportune time. This module allows you to run this task on your own schedule, so you incur the CPU hit at some more convenient and controlled time. U(https://docs.microsoft.com/en-us/dotnet/framework/tools/ngen-exe-native-image-generator#native-image-service) U(http://blogs.msdn.com/b/dotnet/archive/2013/08/06/wondering-why-mscorsvw-exe-has-high-cpu-usage-you-can-speed-it-up.aspx)

Win Dsc *arguments

Invokes a PowerShell DSC configuration

Arguments: free_form, module_version, resource_name

Configures a resource using PowerShell DSC. Requires PowerShell version 5.0 or newer. Most of the options for this module are dynamic and will vary depending on the DSC Resource specified in I(resource_name). See :doc:/user_guide/windows_dsc for more information on how to use this module.

Win Environment *arguments

Modify environment variables on windows hosts

Arguments: state, name, value, level

Uses .net Environment to set or remove environment variables and can set at User, Machine or Process level. User level environment variables will be set, but not available until the user has logged off and on again.

Win Eventlog *arguments

Manage Windows event logs

Arguments: parameter_file, name, overflow_action, retention_days, sources, state, message_file, maximum_size, category_file

Allows the addition, clearing and removal of local Windows event logs, and the creation and removal of sources from a given event log. Also allows the specification of settings per log and source.

Win Eventlog Entry *arguments

Write entries to Windows event logs

Arguments: category, source, log, raw_data, event_id, entry_type, message

Write log entries to a given event log from a specified source.

Win Feature *arguments

Installs and uninstalls Windows Features on Windows Server

Arguments: source, include_management_tools, include_sub_features, state, name

Installs or uninstalls Windows Roles or Features on Windows Server. This module uses the Add/Remove-WindowsFeature Cmdlets on Windows 2008 R2 and Install/Uninstall-WindowsFeature Cmdlets on Windows 2012, which are not available on client os machines.

Win File *arguments

Creates, touches or removes files or directories

Arguments: path, state

Creates (empty) files, updates file modification stamps of existing files, and can create or remove directories. Unlike M(file), does not modify ownership, permissions or manipulate links. For non-Windows targets, use the M(file) module instead.

Win File Version *arguments

Get DLL or EXE file build version

Arguments: path

Get DLL or EXE file build version.

Win Find *arguments

Return a list of files based on specific criteria

Arguments: paths, file_type, checksum_algorithm, age, recurse, age_stamp, patterns, get_checksum, use_regex, follow, hidden, size

Return a list of files based on specified criteria. Multiple criteria are AND'd together. For non-Windows targets, use the M(find) module instead.

Win Firewall *arguments

Enable or disable the Windows Firewall

Arguments: state, profiles

Enable or Disable Windows Firewall profiles.

Win Firewall Rule *arguments

Windows firewall automation

Arguments: remoteport, direction, group, name, service, description, enabled, profiles, localip, state, program, remoteip, action, protocol, localport

Allows you to create/remove/update firewall rules.

Win Format *arguments

Formats an existing volume or a new volume on an existing partition on Windows

Arguments: integrity_streams, full, force, compress, allocation_unit_size, label, new_label, drive_letter, path, large_frs, file_system

The M(win_format) module formats an existing volume or a new volume on an existing partition on Windows

Win Get Url *arguments

Downloads file from HTTP, HTTPS, or FTP to node

Arguments: force, dest, checksum_algorithm, proxy_password, client_cert_password, use_proxy, url, checksum, proxy_url, maximum_redirection, client_cert, headers, checksum_url, proxy_username, follow_redirects, method

Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server I(must) have direct access to the remote resource. For non-Windows targets, use the M(get_url) module instead.

Win Group *arguments

Add and remove local groups

Arguments: state, name, description

Add and remove local groups. For non-Windows targets, please use the M(group) module instead.

Win Group Membership *arguments

Manage Windows local group membership

Arguments: state, name, members

Allows the addition and removal of local, service and domain users, and domain groups from a local group.

Win Hostname *arguments

Manages local Windows computer name

Arguments: name

Manages local Windows computer name. A reboot is required for the computer name to take effect.

Win Hosts *arguments

Manages hosts file entries on Windows.

Arguments: action, state, ip_address, canonical_name, aliases

Manages hosts file entries on Windows. Maps IPv4 or IPv6 addresses to canonical names. Adds, removes, or sets cname records for ip and hostname pairs. Modifies %windir%\\system32\\drivers\\etc\\hosts.

Win Hotfix *arguments

Install and uninstalls Windows hotfixes

Arguments: hotfix_identifier, state, hotfix_kb, source

Install, uninstall a Windows hotfix.

Win Http Proxy *arguments

Manages proxy settings for WinHTTP

Arguments: source, proxy, bypass

Used to set, remove, or import proxy settings for Windows HTTP Services C(WinHTTP). WinHTTP is a framework used by applications or services, typically .NET applications or non-interactive services, to make web requests.

Win Iis Virtualdirectory *arguments

Configures a virtual directory in IIS

Arguments: application, state, name, physical_path, site

Creates, Removes and configures a virtual directory in IIS.

Win Iis Webapplication *arguments

Configures IIS web applications

Arguments: state, application_pool, name, physical_path, site

Creates, removes, and configures IIS web applications.

Win Iis Webapppool *arguments

Configure IIS Web Application Pools

Arguments: attributes, state, name

Creates, removes and configures an IIS Web Application Pool.

Win Iis Webbinding *arguments

Configures a IIS Web site binding

Arguments: protocol, name, certificate_hash, ip, host_header, state, certificate_store_name, port, ssl_flags

Creates, removes and configures a binding to an existing IIS Web site.

Win Iis Website *arguments

Configures a IIS Web site

Arguments: application_pool, name, parameters, ip, physical_path, hostname, site_id, ssl, state, port

Creates, Removes and configures a IIS Web site.

Win Inet Proxy *arguments

Manages proxy settings for WinINet and Internet Explorer

Arguments: connection, auto_config_url, auto_detect, bypass, proxy

Used to set or remove proxy settings for Windows INet which includes Internet Explorer. WinINet is a framework used by interactive applications to submit web requests through. The proxy settings can also be used by other applications like Firefox, Chrome, and others but there is no definitive list.

Win Lineinfile *arguments

Ensure a particular line is in a file, or replace an existing line using a back-referenced regular expression

Arguments: regex, insertbefore, encoding, create, newline, backrefs, state, insertafter, path, line, backup, validate

This module will search a file for a line, and ensure that it is present or absent. This is primarily useful when you want to change a single line in a file only.

Win Mapped Drive *arguments

Map network drives for users

Arguments: username, path, state, password, letter

Allows you to modify mapped network drives for individual users. Also support WebDAV endpoints in the UNC form.

Win Msg *arguments

Sends a message to logged in users on Windows hosts

Arguments: msg, to, display_seconds, wait

Wraps the msg.exe command in order to send messages to Windows hosts.

Win Netbios *arguments

Manage NetBIOS over TCP/IP settings on Windows.

Arguments: state, adapter_names

Enables or disables NetBIOS on Windows network adapters. Can be used to protect a system against NBT-NS poisoning and avoid NBNS broadcast storms. Settings can be applied system wide or per adapter.

Win Nssm *arguments

Install a service using NSSM

Arguments: executable, display_name, name, start_mode, description, state, application, stderr_file, dependencies, working_directory, user, password, stdout_file, app_parameters, arguments

Install a Windows service using the NSSM wrapper. NSSM is a service helper which doesn't suck. See U(https://nssm.cc/) for more information.

Win Optional Feature *arguments

Manage optional Windows features

Arguments: source, state, name, include_parent

Install or uninstall optional Windows features on non-Server Windows. This module uses the C(Enable-WindowsOptionalFeature) and C(Disable-WindowsOptionalFeature) cmdlets.

Win Owner *arguments

Set owner

Arguments: path, recurse, user

Set owner of files or directories.

Win Package *arguments

Installs/uninstalls an installable package

Arguments: username, chdir, product_id, creates_service, creates_path, log_path, state, arguments, expected_return_code, creates_version, path, password, validate_certs

Installs or uninstalls a package in either an MSI or EXE format. These packages can be sources from the local file system, network file share or a url. Please read the notes section around some caveats with this module.

Win Pagefile *arguments

Query or change pagefile configuration

Arguments: test_path, initial_size, drive, state, system_managed, remove_all, override, maximum_size, automatic

Query current pagefile configuration. Enable/Disable AutomaticManagedPagefile. Create new or override pagefile configuration.

Win Partition *arguments

Creates, changes and removes partitions on Windows Server

Arguments: partition_size, read_only, gpt_type, disk_number, partition_number, active, state, drive_letter, mbr_type, hidden, offline

The M(win_partition) module can create, modify or delete a partition on a disk

Win Path *arguments

Manage Windows path environment variables

Arguments: scope, state, elements, name

Allows element-based ordering, addition, and removal of Windows path environment variables.

Win Pester *arguments

Run Pester tests on Windows hosts

Arguments: test_parameters, path, version, tags

Run Pester tests on Windows hosts. Test files have to be available on the remote host.

Win Ping *arguments

A windows version of the classic ping module

Arguments: data

Checks management connectivity of a windows host. This is NOT ICMP ping, this is just a trivial test module. For non-Windows targets, use the M(ping) module instead. For Network targets, use the M(net_ping) module instead.

Win Power Plan *arguments

Changes the power plan of a Windows system

Arguments: name

This module will change the power plan of a Windows system to the defined string. Windows defaults to C(balanced) which will cause CPU throttling. In some cases it can be preferable to change the mode to C(high performance) to increase CPU performance.

Win Product Facts *arguments

Provides Windows product and license information

Arguments:

Provides Windows product and license information.

Win Psexec *arguments

Runs commands (remotely) as another (privileged) user

Arguments: username, limited, session, extra_opts, password, wait, executable, chdir, noprofile, system, elevated, priority, hostnames, command, timeout, nobanner, interactive

Run commands (remotely) through the PsExec service. Run commands as another (domain) user (with elevated privileges).

Win Psmodule *arguments

Adds or removes a Windows PowerShell module

Arguments: allow_clobber, name, repository, allow_prerelease, maximum_version, skip_publisher_check, state, url, required_version, minimum_version

This module helps to install Windows PowerShell modules and register custom modules repository on Windows-based systems.

Win Psrepository *arguments

Adds, removes or updates a Windows PowerShell repository.

Arguments: source, state, name, installation_policy

This module helps to add, remove and update Windows PowerShell repository on Windows-based systems.

Win Rabbitmq Plugin *arguments

Manage RabbitMQ plugins

Arguments: state, new_only, prefix, names

Manage RabbitMQ plugins.

Win Rds Cap *arguments

Manage Connection Authorization Policies (CAP) on a Remote Desktop Gateway server

Arguments: computer_groups, name, session_timeout_action, redirect_drives, redirect_serial, redirect_printers, user_groups, order, idle_timeout, state, allow_only_sdrts_servers, redirect_clipboard, session_timeout, auth_method, redirect_pnp

Creates, removes and configures a Remote Desktop connection authorization policy (RD CAP). A RD CAP allows you to specify the users who can connect to a Remote Desktop Gateway server.

Win Rds Rap *arguments

Manage Resource Authorization Policies (RAP) on a Remote Desktop Gateway server

Arguments: allowed_ports, computer_group_type, state, name, computer_group, description, user_groups

Creates, removes and configures a Remote Desktop resource authorization policy (RD RAP). A RD RAP allows you to specify the network resources (computers) that users can connect to remotely through a Remote Desktop Gateway server.

Win Rds Settings *arguments

Manage main settings of a Remote Desktop Gateway server

Arguments: certificate_hash, enable_only_messaging_capable_clients, ssl_bridging, max_connections

Configure general settings of a Remote Desktop Gateway server.

Win Reboot *arguments

Reboot a windows machine

Arguments: pre_reboot_delay, post_reboot_delay, test_command, shutdown_timeout, reboot_timeout, msg, connect_timeout

Reboot a Windows machine, wait for it to go down, come back up, and respond to commands. For non-Windows targets, use the M(reboot) module instead.

Win Reg Stat *arguments

Get information about Windows registry keys

Arguments: path, name

Like M(win_file), M(win_reg_stat) will return whether the key/property exists. It also returns the sub keys and properties of the key specified. If specifying a property name through I(property), it will return the information specific for that property.

Win Regedit *arguments

Add, change, or remove registry keys and values

Arguments: state, delete_key, name, path, type, hive, data

Add, modify or remove registry keys and values. More information about the windows registry from Wikipedia U(https://en.wikipedia.org/wiki/Windows_Registry).

Win Region *arguments

Set the region and format settings

Arguments: unicode_language, copy_settings, location, format

Set the location settings of a Windows Server. Set the format settings of a Windows Server. Set the unicode language settings of a Windows Server. Copy across these settings to the default profile.

Win Regmerge *arguments

Merges the contents of a registry file into the Windows registry

Arguments: path, compare_key

Wraps the reg.exe command to import the contents of a registry file. Suitable for use with registry files created using M(win_template). Windows registry files have a specific format and must be constructed correctly with carriage return and line feed line endings otherwise they will not be merged. Exported registry files often start with a Byte Order Mark which must be removed if the file is to templated using M(win_template). Registry file format is described at U(https://support.microsoft.com/en-us/kb/310516) See also M(win_template), M(win_regedit)

Win Robocopy *arguments

Synchronizes the contents of two directories using Robocopy

Arguments: dest, src, recurse, purge, flags

Synchronizes the contents of files/directories from a source to destination. Under the hood this just calls out to RoboCopy, since that should be available on most modern Windows systems.

Win Route *arguments

Add or remove a static route

Arguments: metric, destination, gateway, state

Add or remove a static route.

Win Say *arguments

Text to speech module for Windows to speak messages and optionally play sounds

Arguments: end_sound_path, msg, start_sound_path, voice, msg_file, speech_speed

Uses .NET libraries to convert text to speech and optionally play .wav sounds. Audio Service needs to be running and some kind of speakers or headphones need to be attached to the windows target(s) for the speech to be audible.

Win Scheduled Task *arguments

Manage scheduled tasks

Arguments: run_only_if_network_available, update_password, execution_time_limit, actions, group, wake_to_run, run_only_if_idle, display_name, author, restart_count, compatibility, priority, source, state, version, allow_demand_start, logon_type, hidden, username, stop_if_going_on_batteries, disallow_start_if_on_batteries, description, delete_expired_task_after, restart_interval, start_when_available, date, path, password, run_level, multiple_instances, name, triggers, enabled, allow_hard_terminate

Creates/modified or removes Windows scheduled tasks.

Win Scheduled Task Stat *arguments

Get information about Windows Scheduled Tasks

Arguments: path, name

Will return whether the folder and task exists. Returns the names of tasks in the folder specified. Use M(win_scheduled_task) to configure a scheduled task.

Win Security Policy *arguments

Change local security policy settings

Arguments: section, key, value

Allows you to set the local security policies that are configured by SecEdit.exe.

Win Service *arguments

Manage and query Windows services

Arguments: username, display_name, desktop_interact, force_dependent_services, dependency_action, description, start_mode, state, dependencies, path, password, name

Manage and query Windows services. For non-Windows targets, use the M(service) module instead.

Win Share *arguments

Manage Windows shares

Arguments: deny, full, encrypt, name, read, list, state, caching_mode, path, change, description

Add, modify or remove Windows share and set share permissions.

Win Shell *arguments

Execute shell commands on target hosts

Arguments: creates, executable, chdir, stdin, removes, free_form, no_profile

The C(win_shell) module takes the command name followed by a list of space-delimited arguments. It is similar to the M(win_command) module, but runs the command via a shell (defaults to PowerShell) on the target host. For non-Windows targets, use the M(shell) module instead.

Win Shortcut *arguments

Manage shortcuts on Windows

Arguments: windowstyle, src, description, run_as_admin, dest, directory, state, arguments, hotkey, icon

Create, manage and delete Windows shortcuts

Win Snmp *arguments

Configures the Windows SNMP service

Arguments: action, permitted_managers, community_strings

This module configures the Windows SNMP service.

Win Stat *arguments

Get information about Windows files

Arguments: checksum_algorithm, path, get_md5, get_checksum, follow

Returns information about a Windows file. For non-Windows targets, use the M(stat) module instead.

Win Tempfile *arguments

Creates temporary files and directories

Arguments: path, state, prefix, suffix

Creates temporary files and directories. For non-Windows targets, please use the M(tempfile) module instead.

Win Template *arguments

Template a file out to a remote server

Arguments: force, newline_sequence, backup

Template a file out to a remote server

Win Timezone *arguments

Sets Windows machine timezone

Arguments: timezone

Sets machine time to the specified timezone.

Win Toast *arguments

Sends Toast windows notification to logged in users on Windows 10 or later hosts

Arguments: popup, group, expire, title, msg, tag

Sends alerts which appear in the Action Center area of the windows desktop.

Win Unzip *arguments

Unzips compressed files and archives on the Windows node

Arguments: dest, src, delete_archive, recurse, creates

Unzips compressed files and archives. Supports .zip files natively. Supports other formats supported by the Powershell Community Extensions (PSCX) module (basically everything 7zip supports). For non-Windows targets, use the M(unarchive) module instead.

Win Updates *arguments

Download and install Windows updates

Arguments: reboot_timeout, log_path, whitelist, category_names, reboot, use_scheduled_task, blacklist, state, server_selection

Searches, downloads, and installs Windows updates synchronously by automating the Windows Update client.

Win Uri *arguments

Interacts with webservices

Arguments: body, dest, status_code, removes, proxy_password, client_cert_password, content_type, url_password, use_proxy, url, proxy_url, maximum_redirection, method, creates, proxy_username, url_username, follow_redirects, return_content, client_cert

Interacts with FTP, HTTP and HTTPS web services. Supports Digest, Basic and WSSE HTTP authentication mechanisms. For non-Windows targets, use the M(uri) module instead.

Win User *arguments

Manages local Windows user accounts

Arguments: update_password, password, name, description, groups_action, password_expired, state, groups, account_disabled, fullname, password_never_expires, account_locked, user_cannot_change_password

Manages local Windows user accounts. For non-Windows targets, use the M(user) module instead.

Win User Profile *arguments

Manages the Windows user profiles.

Arguments: username, state, remove_multiple, name

Used to create or remove user profiles on a Windows host. This can be used to create a profile before a user logs on or delete a profile when removing a user account. A profile can be created for both a local or domain account.

Win User Right *arguments

Manage Windows User Rights

Arguments: action, name, users

Add, remove or set User Rights for a group or users or groups. You can set user rights for both local and domain accounts.

Win Wait For *arguments

Waits for a condition before continuing

Arguments: regex, host, port, delay, state, sleep, timeout, exclude_hosts, path, connect_timeout

You can wait for a set amount of time C(timeout), this is the default if nothing is specified. Waiting for a port to become available is useful for when services are not immediately available after their init scripts return which is true of certain Java application servers. You can wait for a file to exist or not exist on the filesystem. This module can also be used to wait for a regex match string to be present in a file. You can wait for active connections to be closed before continuing on a local port.

Win Wait For Process *arguments

Waits for a process to exist or not exist before continuing.

Arguments: process_name_pattern, process_name_exact, post_wait_delay, process_min_count, pid, state, pre_wait_delay, sleep, timeout, owner

Waiting for a process to start or stop. This is useful when Windows services behave poorly and do not enumerate external dependencies in their manifest.

Win Wakeonlan *arguments

Send a magic Wake-on-LAN (WoL) broadcast packet

Arguments: broadcast, mac, port

The C(win_wakeonlan) module sends magic Wake-on-LAN (WoL) broadcast packets. For non-Windows targets, use the M(wakeonlan) module instead.

Win Webpicmd *arguments

Installs packages using Web Platform Installer command-line

Arguments: name

Installs packages using Web Platform Installer command-line (U(http://www.iis.net/learn/install/web-platform-installer/web-platform-installer-v4-command-line-webpicmdexe-rtw-release)). Must be installed and present in PATH (see M(win_chocolatey) module; 'webpicmd' is the package name, and you must install 'lessmsi' first too)? Install IIS first (see M(win_feature) module).

Win Whoami *arguments

Get information about the current user and process

Arguments:

Designed to return the same information as the C(whoami /all) command. Also includes information missing from C(whoami) such as logon metadata like logon rights, id, type.

Win Xml *arguments

Manages XML file content on Windows hosts

Arguments: count, xpath, backup, fragment, attribute, state, path, type

Manages XML nodes, attributes and text, using xpath to select which xml nodes need to be managed. XML fragments, formatted as strings, are used to specify the desired state of a part or parts of XML files on remote Windows servers. For non-Windows targets, use the M(xml) module instead.

Xattr *arguments

Manage user defined extended attributes

Arguments: state, key, path, follow, namespace, value

Manages filesystem user defined extended attributes. Requires that extended attributes are enabled on the target filesystem and that the setfattr/getfattr utilities are present.

Xbps *arguments

Manage packages with XBPS

Arguments: recurse, state, upgrade, update_cache, name

Manage packages with the XBPS package manager.

Xenserver Facts *arguments

get facts reported on xenserver

Arguments:

Reads data out of XenAPI, can be used instead of multiple xe commands.

Xenserver Guest *arguments

Manages virtual machines running on Citrix Hypervisor/XenServer host or pool

Arguments: uuid, force, name_desc, hardware, cdrom, home_server, networks, wait_for_ip_address, template_uuid, state_change_timeout, custom_params, name, disks, state, is_template, template, linked_clone, folder

This module can be used to create new virtual machines from templates or other virtual machines, modify various virtual machine components like network and disk, rename a virtual machine and remove a virtual machine with associated components.

Xenserver Guest Info *arguments

Gathers information for virtual machines running on Citrix Hypervisor/XenServer host or pool

Arguments: name, uuid

This module can be used to gather essential VM facts.

Xenserver Guest Powerstate *arguments

Manages power states of virtual machines running on Citrix Hypervisor/XenServer host or pool

Arguments: uuid, state_change_timeout, state, name, wait_for_ip_address

This module can be used to power on, power off, restart or suspend virtual machine and gracefully reboot or shutdown guest OS of virtual machine.

Xfconf *arguments

Edit XFCE4 Configurations

Arguments: state, property, value_type, channel, value

This module allows for the manipulation of Xfce 4 Configuration via xfconf-query. Please see the xfconf-query(1) man pages for more details.

Xfs Quota *arguments

Manage quotas on XFS filesystems

Arguments: rtbsoft, name, type, ihard, bhard, state, bsoft, isoft, mountpoint, rtbhard

Configure quotas on XFS filesystems. Before using this module /etc/projects and /etc/projid need to be configured.

Xml *arguments

Manage bits and pieces of XML files or strings

Arguments: xpath, set_children, attribute, pretty_print, print_match, namespaces, insertafter, path, count, xmlstring, insertbefore, strip_cdata_tags, input_type, add_children, value, content, state, backup

A CRUD-like interface to managing bits of XML files.

Yarn *arguments

Manage node.js packages with Yarn

Arguments: executable, name, global, ignore_scripts, state, production, registry, version, path

Manage node.js packages with the Yarn package manager (https://yarnpkg.com/)

Yum *arguments

Manages packages with the I(yum) package manager

Arguments: install_weak_deps, autoremove, lock_timeout, download_dir, enable_plugin, update_cache, disable_excludes, exclude, update_only, installroot, allow_downgrade, name, download_only, bugfix, list, disable_gpg_check, conf_file, use_backend, state, disablerepo, releasever, disable_plugin, enablerepo, skip_broken, security, validate_certs

Installs, upgrade, downgrades, removes, and lists packages and groups with the I(yum) package manager. This module only works on Python 2. If you require Python 3 support see the M(dnf) module.

Yum Repository *arguments

Add or remove YUM repositories

Arguments: ip_resolve, enabled, proxy_password, bandwidth, cost, file, mirrorlist_expire, exclude, keepalive, repo_gpgcheck, sslverify, failovermethod, deltarpm_metadata_percentage, gpgkey, http_caching, priority, state, mirrorlist, gpgcheck, include, proxy_username, username, metadata_expire, description, retries, sslclientcert, baseurl, gpgcakey, s3_enabled, includepkgs, enablegroups, password, ui_repoid_vars, protect, ssl_check_cert_permissions, throttle, name, deltarpm_percentage, sslclientkey, metalink, reposdir, skip_if_unavailable, keepcache, sslcacert, timeout, async, metadata_expire_filter, proxy

Add or remove YUM repositories in RPM-based Linux distributions. If you wish to update an existing repository definition use M(ini_file) instead.

Zabbix Action *arguments

Create/Delete/Update Zabbix actions

Arguments: status, operations, esc_period, default_message, acknowledge_default_subject, recovery_default_subject, default_subject, formula, recovery_operations, event_source, name, recovery_default_message, pause_in_maintenance, acknowledge_operations, eval_type, state, acknowledge_default_message, conditions

This module allows you to create, modify and delete Zabbix actions.

Zabbix Group *arguments

Create/delete Zabbix host groups

Arguments: state, host_groups

Create host groups if they do not exist. Delete existing host groups if they exist.

Zabbix Group Info *arguments

Gather information about Zabbix hostgroup

Arguments: hostgroup_name

This module allows you to search for Zabbix hostgroup entries. This module was called C(zabbix_group_facts) before Ansible 2.9. The usage did not change.

Zabbix Host *arguments

Create/update/delete Zabbix hosts

Arguments: status, force, description, ca_cert, interfaces, tls_accept, ipmi_username, ipmi_authtype, proxy, host_groups, inventory_zabbix, inventory_mode, tls_psk_identity, tls_psk, ipmi_privilege, tls_connect, ipmi_password, visible_name, state, host_name, tls_subject, link_templates

This module allows you to create, modify and delete Zabbix host entries and associated group and template data.

Zabbix Host Info *arguments

Gather information about Zabbix host

Arguments: remove_duplicate, exact_match, host_name, host_ip, host_inventory

This module allows you to search for Zabbix host entries. This module was called C(zabbix_host_facts) before Ansible 2.9. The usage did not change.

Zabbix Hostmacro *arguments

Create/update/delete Zabbix host macros

Arguments: macro_name, macro_value, state, force, host_name

manages Zabbix host macros, it can create, update or delete them.

Zabbix Maintenance *arguments

Create Zabbix maintenance windows

Arguments: state, name, host_groups, collect_data, minutes, host_names, desc

This module will let you create Zabbix maintenance windows.

Zabbix Map *arguments

Create/update/delete Zabbix maps

Arguments: label_type, name, margin, expand_problem, height, width, state, default_image, highlight, data

This module allows you to create, modify and delete Zabbix map entries, using Graphviz binaries and text description written in DOT language. Nodes of the graph will become map elements and edges will become links between map elements. See U(https://en.wikipedia.org/wiki/DOT_(graph_description_language)) and U(https://www.graphviz.org/) for details. Inspired by U(http://blog.zabbix.com/maps-for-the-lazy/). The following extra node attributes are supported: C(zbx_host) contains name of the host in Zabbix. Use this if desired type of map element is C(host). C(zbx_group) contains name of the host group in Zabbix. Use this if desired type of map element is C(host group). C(zbx_map) contains name of the map in Zabbix. Use this if desired type of map element is C(map). C(zbx_label) contains label of map element. C(zbx_image) contains name of the image used to display the element in default state. C(zbx_image_disabled) contains name of the image used to display disabled map element. C(zbx_image_maintenance) contains name of the image used to display map element in maintenance. C(zbx_image_problem) contains name of the image used to display map element with problems. C(zbx_url) contains map element URL in C(name:url) format. More than one URL could be specified by adding a postfix (e.g., C(zbx_url1), C(zbx_url2)). The following extra link attributes are supported: C(zbx_draw_style) contains link line draw style. Possible values: C(line), C(bold), C(dotted), C(dashed). C(zbx_trigger) contains name of the trigger used as a link indicator in C(host_name:trigger_name) format. More than one trigger could be specified by adding a postfix (e.g., C(zbx_trigger1), C(zbx_trigger2)). C(zbx_trigger_color) contains indicator color specified either as CSS3 name or as a hexadecimal code starting with C(#). C(zbx_trigger_draw_style) contains indicator draw style. Possible values are the same as for C(zbx_draw_style).

Zabbix Mediatype *arguments

Create/Update/Delete Zabbix media types

Arguments: status, username, smtp_authentication, gsm_modem, attempt_interval, script_name, max_sessions, smtp_security, password, smtp_server_port, name, smtp_email, smtp_helo, smtp_verify_peer, smtp_server, state, message_text_limit, smtp_verify_host, script_params, type, max_attempts

This module allows you to create, modify and delete Zabbix media types.

Zabbix Proxy *arguments

Create/delete/get/update Zabbix proxies

Arguments: status, tls_psk, description, ca_cert, tls_connect, tls_accept, proxy_name, state, interface, tls_subject, tls_psk_identity

This module allows you to create, modify, get and delete Zabbix proxy entries.

Zabbix Screen *arguments

Create/update/delete Zabbix screens

Arguments: screens

This module allows you to create, modify and delete Zabbix screens and associated graph data.

Zabbix Template *arguments

Create/update/delete/dump Zabbix template

Arguments: clear_templates, template_name, template_json, macros, state, dump_format, template_xml, template_groups, link_templates

This module allows you to create, modify, delete and dump Zabbix templates. Multiple templates can be created or modified at once if passing JSON or XML to module.

Zfs *arguments

Manage zfs

Arguments: origin, state, extra_zfs_properties, name

Manages ZFS file systems, volumes, clones and snapshots

Zfs Delegate Admin *arguments

Manage ZFS delegated administration (user admin privileges)

Arguments: everyone, name, descendents, state, groups, users, permissions, local, recursive

Manages ZFS file system delegated administration permissions, which allow unprivileged users to perform ZFS operations normally restricted to the superuser. See the C(zfs allow) section of C(zfs(1M)) for detailed explanations of options. This module attempts to adhere to the behavior of the command line tool as much as possible.

Zfs Facts *arguments

Gather facts about ZFS datasets.

Arguments: parsable, depth, name, type, recurse, properties

Gather facts from ZFS dataset properties.

Znode *arguments

Create, delete, retrieve, and update znodes using ZooKeeper

Arguments: state, hosts, name, timeout, op, value, recursive

Create, delete, retrieve, and update znodes using ZooKeeper.

Zpool Facts *arguments

Gather facts about ZFS pools.

Arguments: parsable, name, properties

Gather facts from ZFS pool properties.

Zypper *arguments

Manage packages on SUSE and openSUSE

Arguments: extra_args_precommand, force, name, disable_gpg_check, extra_args, state, oldpackage, update_cache, disable_recommends, type

Manage packages on SUSE and openSUSE using the zypper and rpm tools.

Zypper Repository *arguments

Add and remove Zypper repositories

Arguments: repo, name, auto_import_keys, enabled, disable_gpg_check, priority, state, autorefresh, overwrite_multiple, runrefresh, description

Add or remove Zypper repositories on SUSE and openSUSE